From c695616b3f6f11887fd1a12119156909798d75bb Mon Sep 17 00:00:00 2001 From: yoshi-code-bot <70984784+yoshi-code-bot@users.noreply.github.com> Date: Tue, 10 Sep 2024 00:40:28 -0700 Subject: [PATCH 1/2] chore: Update discovery artifacts (#2479) ## Deleted keys were detected in the following stable discovery artifacts: cloudasset v1 https://togithub.com/googleapis/google-api-python-client/commit/c2fe812c59e334d32025a5453beca0343c60491f ## Deleted keys were detected in the following pre-stable discovery artifacts: migrationcenter v1alpha1 https://togithub.com/googleapis/google-api-python-client/commit/7ccb8790fc04acbfe8e677c53b42e969c7416376 ## Discovery Artifact Change Summary: feat(aiplatform): update the api https://togithub.com/googleapis/google-api-python-client/commit/b0e9b7088d0a9874dfd3fa76c2256c945ddfa5f4 feat(alloydb): update the api https://togithub.com/googleapis/google-api-python-client/commit/4248bcaae79888c7d2f598116c540d94ab295f5a feat(androidmanagement): update the api https://togithub.com/googleapis/google-api-python-client/commit/9cd85f7ba60141ea19dd65190896a417ef0b1fbe feat(apigee): update the api https://togithub.com/googleapis/google-api-python-client/commit/93f395ddde6e1c52e15ce006840f011b71418fec feat(artifactregistry): update the api https://togithub.com/googleapis/google-api-python-client/commit/ae7e87ba4ab148581cc3b79f0bf1846ee1ed3123 feat(backupdr): update the api https://togithub.com/googleapis/google-api-python-client/commit/c4fac8cd319b299aecc9d751e715877b54325365 feat(baremetalsolution): update the api https://togithub.com/googleapis/google-api-python-client/commit/d416775786ef684ee99946cb923d23dbfa50714b feat(chat): update the api https://togithub.com/googleapis/google-api-python-client/commit/96b0c11f8fde539acf84538a91b3bc0248a80165 feat(checks): update the api https://togithub.com/googleapis/google-api-python-client/commit/f6ac594b0d758bc999d982194f6bf1a1178e6024 feat(cloudasset): update the api https://togithub.com/googleapis/google-api-python-client/commit/c2fe812c59e334d32025a5453beca0343c60491f fix(cloudkms): update the api https://togithub.com/googleapis/google-api-python-client/commit/960560970e66bcf40378467352894afc4b4c9101 feat(compute): update the api https://togithub.com/googleapis/google-api-python-client/commit/57a39ac8205dd44a8a4104f2e43a531eb3c9d90c feat(connectors): update the api https://togithub.com/googleapis/google-api-python-client/commit/7722e6e017454a5a367a81247fe01a1854653b32 feat(contactcenteraiplatform): update the api https://togithub.com/googleapis/google-api-python-client/commit/5ea2f0bd58deb72d7f5fe5ebd0321178e4b429b6 feat(container): update the api https://togithub.com/googleapis/google-api-python-client/commit/81dc9c948eb1d04a8328476d76f4168922009016 feat(containeranalysis): update the api https://togithub.com/googleapis/google-api-python-client/commit/76f58d51386bfd92ef74db15a89d64142242a293 feat(discoveryengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/88a5b5f17d5dd0642c9bf820b19c79d080fe7e45 feat(dlp): update the api https://togithub.com/googleapis/google-api-python-client/commit/8d4b2d2e9780e634f416d27cd508d9e1a9936bd9 feat(drive): update the api https://togithub.com/googleapis/google-api-python-client/commit/2ec82eefa3f0beab2ea3b782167cf4eeb1c9c67d feat(file): update the api https://togithub.com/googleapis/google-api-python-client/commit/d81a62a6d9361e0c7105d190fca181d9f8ee0a51 feat(gkehub): update the api https://togithub.com/googleapis/google-api-python-client/commit/aa5e1571c5139293553159dc9a416ee0239f2000 feat(healthcare): update the api https://togithub.com/googleapis/google-api-python-client/commit/7eb47bf628eaa3566278c81803fa906a631e2882 feat(integrations): update the api https://togithub.com/googleapis/google-api-python-client/commit/3060536a781563e759bdf83608176f8465682318 feat(logging): update the api https://togithub.com/googleapis/google-api-python-client/commit/b784bf0186abbacd9b040ae4f42c465ab428c136 feat(migrationcenter): update the api https://togithub.com/googleapis/google-api-python-client/commit/7ccb8790fc04acbfe8e677c53b42e969c7416376 feat(monitoring): update the api https://togithub.com/googleapis/google-api-python-client/commit/da429bd49ae672d251a5d1e4972484f05dbcc684 feat(networksecurity): update the api https://togithub.com/googleapis/google-api-python-client/commit/baac341fa5fc8cc15176bf0ab83ffb9f3adfe306 feat(redis): update the api https://togithub.com/googleapis/google-api-python-client/commit/22f6a96c896e1af1cd8a0d49dc1bdb5458569024 feat(run): update the api https://togithub.com/googleapis/google-api-python-client/commit/52b287d546f7df0048880e1cb2451b1f84ea266a fix(spanner): update the api https://togithub.com/googleapis/google-api-python-client/commit/cf162c2c525054e0cdad889ca15fd9b5f29ae1d2 feat(sqladmin): update the api https://togithub.com/googleapis/google-api-python-client/commit/1769e73def4dfc8daad50d7a19cc6a8d43ee6ba1 --- ...irectory_v1.customer.devices.chromeos.html | 2 +- docs/dyn/aiplatform_v1.endpoints.html | 116 +- ...ations.datasets.dataItems.annotations.html | 4 +- ...tform_v1.projects.locations.endpoints.html | 116 +- ...m_v1.projects.locations.featureGroups.html | 8 + ...ions.featureOnlineStores.featureViews.html | 142 +- ...rojects.locations.featureOnlineStores.html | 124 ++ ....projects.locations.publishers.models.html | 116 +- ...form_v1.projects.locations.tuningJobs.html | 8 +- docs/dyn/aiplatform_v1.publishers.models.html | 116 +- docs/dyn/aiplatform_v1beta1.endpoints.html | 40 +- docs/dyn/aiplatform_v1beta1.media.html | 8 + ...ta1.projects.locations.cachedContents.html | 90 +- ...ations.datasets.dataItems.annotations.html | 4 +- ..._v1beta1.projects.locations.endpoints.html | 40 +- ...v1beta1.projects.locations.extensions.html | 24 +- ...eta1.projects.locations.featureGroups.html | 8 + ...ions.featureOnlineStores.featureViews.html | 18 +- ....projects.locations.publishers.models.html | 40 +- ...v1beta1.projects.locations.ragCorpora.html | 150 ++ ...rojects.locations.ragCorpora.ragFiles.html | 8 + ...v1beta1.projects.locations.tuningJobs.html | 16 +- .../aiplatform_v1beta1.publishers.models.html | 40 +- ...lloydb_v1.projects.locations.clusters.html | 48 + ...projects.locations.clusters.instances.html | 20 + ...db_v1beta.projects.locations.clusters.html | 48 + ...oidmanagement_v1.enterprises.policies.html | 16 +- ...izations.environments.securityActions.html | 18 + ...projects.locations.repositories.files.html | 2 +- ...ry_v1.projects.locations.repositories.html | 17 +- ...jects.locations.repositories.packages.html | 2 +- ....locations.repositories.packages.tags.html | 2 +- ...ations.repositories.packages.versions.html | 2 +- ...projects.locations.repositories.files.html | 2 +- ....locations.repositories.packages.tags.html | 2 +- ...projects.locations.repositories.files.html | 2 +- ....locations.repositories.packages.tags.html | 2 +- ...ions.backupVaults.dataSources.backups.html | 9 + ...rojects.locations.provisioningConfigs.html | 21 +- docs/dyn/chat_v1.spaces.messages.html | 40 + docs/dyn/chat_v1.spaces.spaceEvents.html | 60 + docs/dyn/checks_v1alpha.accounts.html | 5 + docs/dyn/checks_v1alpha.accounts.repos.html | 91 ++ ...cks_v1alpha.accounts.repos.operations.html | 124 ++ docs/dyn/cloudasset_v1.operations.html | 48 - docs/dyn/cloudasset_v1.v1.html | 2 +- ...dbuild_v1.projects.locations.triggers.html | 12 +- docs/dyn/cloudbuild_v1.projects.triggers.html | 12 +- docs/dyn/compute_alpha.html | 5 + docs/dyn/compute_alpha.regionCommitments.html | 18 + ...ionInstanceGroupManagerResizeRequests.html | 260 +++ docs/dyn/compute_alpha.reservationBlocks.html | 197 +++ docs/dyn/compute_alpha.reservations.html | 15 + ...ompute_v1.globalNetworkEndpointGroups.html | 3 + .../dyn/compute_v1.networkEndpointGroups.html | 3 + ...ompute_v1.regionNetworkEndpointGroups.html | 3 + ...ors_v1.projects.locations.connections.html | 115 ++ ...tomConnectors.customConnectorVersions.html | 21 + ...cations.providers.connectors.versions.html | 63 + ...ha1.projects.locations.contactCenters.html | 20 +- ...r_v1beta1.projects.locations.clusters.html | 8 + ...ainer_v1beta1.projects.zones.clusters.html | 8 + ...ysis_v1beta1.projects.locations.notes.html | 140 ++ ...1beta1.projects.locations.occurrences.html | 140 ++ ...ow_v3.projects.locations.agents.flows.html | 12 +- ...jects.locations.agents.flows.versions.html | 10 +- ...3.projects.locations.agents.testCases.html | 4 +- ...ojects.locations.agents.conversations.html | 12 +- ...ocations.agents.environments.sessions.html | 6 +- ...beta1.projects.locations.agents.flows.html | 12 +- ...jects.locations.agents.flows.versions.html | 10 +- ...a1.projects.locations.agents.sessions.html | 6 +- ...1.projects.locations.agents.testCases.html | 4 +- ...ections.dataStores.branches.documents.html | 98 ++ ....collections.dataStores.conversations.html | 14 + ...collections.dataStores.servingConfigs.html | 28 + ...ons.collections.engines.conversations.html | 14 + ...ns.collections.engines.servingConfigs.html | 28 + ...cations.dataStores.branches.documents.html | 98 ++ ...ts.locations.dataStores.conversations.html | 14 + ...s.locations.dataStores.servingConfigs.html | 28 + ...ections.dataStores.branches.documents.html | 98 ++ ....collections.dataStores.conversations.html | 14 + ...collections.dataStores.servingConfigs.html | 42 + ...ons.collections.engines.conversations.html | 14 + ...ns.collections.engines.servingConfigs.html | 42 + ...cations.dataStores.branches.documents.html | 98 ++ ...ts.locations.dataStores.conversations.html | 14 + ...s.locations.dataStores.servingConfigs.html | 42 + ...ections.dataStores.branches.documents.html | 98 ++ ....collections.dataStores.conversations.html | 14 + ...collections.dataStores.servingConfigs.html | 42 + ...ons.collections.engines.conversations.html | 14 + ...ns.collections.engines.servingConfigs.html | 42 + ...cations.dataStores.branches.documents.html | 98 ++ ...ts.locations.dataStores.conversations.html | 14 + ...s.locations.dataStores.servingConfigs.html | 42 + ...anizations.locations.discoveryConfigs.html | 24 + ...tions.locations.fileStoreDataProfiles.html | 16 + ...nizations.locations.tableDataProfiles.html | 16 + ...2.projects.locations.discoveryConfigs.html | 24 + ...jects.locations.fileStoreDataProfiles.html | 16 + ....projects.locations.tableDataProfiles.html | 16 + docs/dyn/drive_v3.files.html | 40 + docs/dyn/drive_v3.html | 10 + docs/dyn/drive_v3.operation.html | 118 ++ docs/dyn/drive_v3.operations.html | 187 +++ .../file_v1.projects.locations.instances.html | 60 + ...le_v1beta1.projects.locations.backups.html | 8 +- ..._v1beta1.projects.locations.instances.html | 114 +- ...rojects.locations.instances.snapshots.html | 8 +- ...gkehub_v1.projects.locations.features.html | 72 +- ...b_v1alpha.projects.locations.features.html | 72 +- ...ub_v1beta.projects.locations.features.html | 72 +- ...ts.locations.datasets.fhirStores.fhir.html | 138 ++ ...ts.locations.datasets.fhirStores.fhir.html | 138 ++ docs/dyn/index.md | 1 + ...ons_v1.projects.locations.connections.html | 22 + docs/dyn/logging_v2.projects.metrics.html | 18 + ...unts_v1beta.accounts.shippingSettings.html | 6 +- ...oncenter_v1.projects.locations.assets.html | 84 +- ...er_v1alpha1.projects.locations.assets.html | 112 +- ...1.projects.locations.assetsExportJobs.html | 66 + ...ha1.projects.locations.preferenceSets.html | 24 +- ...jects.locations.reportConfigs.reports.html | 18 +- ...rojects.locations.sources.errorFrames.html | 8 +- .../monitoring_v1.projects.dashboards.html | 264 +++ ...itoring_v3.projects.metricDescriptors.html | 12 + .../monitoring_v3.projects.timeSeries.html | 8 +- ...rksecurity_v1beta1.projects.locations.html | 20 + ...s.locations.mirroringDeploymentGroups.html | 341 ++++ ...ojects.locations.mirroringDeployments.html | 328 ++++ ...ns.mirroringEndpointGroupAssociations.html | 349 ++++ ...cts.locations.mirroringEndpointGroups.html | 321 ++++ ...rojects.locations.osPolicyAssignments.html | 20 +- .../dyn/run_v2.projects.locations.builds.html | 1 + .../run_v2.projects.locations.services.html | 8 +- ...projects.locations.services.revisions.html | 4 +- .../servicenetworking_v1.services.roles.html | 2 +- docs/dyn/sqladmin_v1.instances.html | 334 ++++ docs/dyn/sqladmin_v1beta4.instances.html | 334 ++++ docs/dyn/vision_v1.files.html | 2 +- docs/dyn/vision_v1.images.html | 2 +- docs/dyn/vision_v1.projects.files.html | 2 +- docs/dyn/vision_v1.projects.images.html | 2 +- .../vision_v1.projects.locations.files.html | 2 +- .../vision_v1.projects.locations.images.html | 2 +- docs/dyn/vision_v1p1beta1.files.html | 2 +- docs/dyn/vision_v1p1beta1.images.html | 2 +- docs/dyn/vision_v1p1beta1.projects.files.html | 2 +- .../dyn/vision_v1p1beta1.projects.images.html | 2 +- ...on_v1p1beta1.projects.locations.files.html | 2 +- ...n_v1p1beta1.projects.locations.images.html | 2 +- docs/dyn/vision_v1p2beta1.files.html | 2 +- docs/dyn/vision_v1p2beta1.images.html | 2 +- docs/dyn/vision_v1p2beta1.projects.files.html | 2 +- .../dyn/vision_v1p2beta1.projects.images.html | 2 +- ...on_v1p2beta1.projects.locations.files.html | 2 +- ...n_v1p2beta1.projects.locations.images.html | 2 +- .../documents/admin.directory_v1.json | 4 +- .../documents/aiplatform.v1.json | 227 ++- .../documents/aiplatform.v1beta1.json | 253 ++- .../discovery_cache/documents/alloydb.v1.json | 115 +- .../documents/alloydb.v1alpha.json | 34 +- .../documents/alloydb.v1beta.json | 106 +- .../documents/androidmanagement.v1.json | 34 +- .../discovery_cache/documents/apigee.v1.json | 9 +- .../documents/appengine.v1.json | 27 +- .../documents/appengine.v1alpha.json | 27 +- .../documents/appengine.v1beta.json | 27 +- .../documents/artifactregistry.v1.json | 27 +- .../documents/artifactregistry.v1beta1.json | 6 +- .../documents/artifactregistry.v1beta2.json | 6 +- .../documents/backupdr.v1.json | 9 +- .../documents/baremetalsolution.v2.json | 8 +- .../discovery_cache/documents/chat.v1.json | 33 +- .../documents/checks.v1alpha.json | 32 +- .../documents/cloudasset.v1.json | 65 +- .../documents/cloudbuild.v1.json | 4 +- .../documents/cloudidentity.v1.json | 4 +- .../documents/cloudidentity.v1beta1.json | 4 +- .../documents/cloudkms.v1.json | 17 +- .../documents/compute.alpha.json | 504 +++++- .../documents/compute.beta.json | 14 +- .../discovery_cache/documents/compute.v1.json | 11 +- .../documents/connectors.v1.json | 265 ++- .../contactcenteraiplatform.v1alpha1.json | 12 +- .../documents/container.v1beta1.json | 8 +- .../documents/containeranalysis.v1beta1.json | 170 +- .../documents/datalineage.v1.json | 8 +- .../documents/datamigration.v1.json | 8 +- .../documents/dialogflow.v3.json | 4 +- .../documents/dialogflow.v3beta1.json | 4 +- .../documents/discoveryengine.v1.json | 128 +- .../documents/discoveryengine.v1alpha.json | 112 +- .../documents/discoveryengine.v1beta.json | 128 +- .../discovery_cache/documents/dlp.v2.json | 22 +- .../discovery_cache/documents/drive.v3.json | 223 ++- .../discovery_cache/documents/file.v1.json | 86 +- .../documents/file.v1beta1.json | 116 +- .../documents/firebaseml.v2beta.json | 8 +- .../discovery_cache/documents/gkehub.v1.json | 26 +- .../documents/gkehub.v1alpha.json | 26 +- .../documents/gkehub.v1beta.json | 26 +- .../documents/healthcare.v1.json | 112 +- .../documents/healthcare.v1beta1.json | 112 +- .../documents/integrations.v1.json | 49 +- .../discovery_cache/documents/logging.v2.json | 21 +- .../merchantapi.accounts_v1beta.json | 4 +- .../documents/migrationcenter.v1.json | 23 +- .../documents/migrationcenter.v1alpha1.json | 118 +- .../documents/monitoring.v1.json | 29 +- .../documents/monitoring.v3.json | 27 +- .../documents/networksecurity.v1.json | 8 +- .../documents/networksecurity.v1beta1.json | 1446 +++++++++++++++-- .../documents/osconfig.v1.json | 6 +- .../documents/osconfig.v1alpha.json | 4 +- .../discovery_cache/documents/redis.v1.json | 410 ++++- .../documents/redis.v1beta1.json | 410 ++++- .../discovery_cache/documents/run.v2.json | 8 +- .../documents/servicenetworking.v1.json | 4 +- .../documents/servicenetworking.v1beta.json | 4 +- .../discovery_cache/documents/spanner.v1.json | 7 +- .../documents/sqladmin.v1.json | 164 +- .../documents/sqladmin.v1beta4.json | 164 +- .../discovery_cache/documents/vision.v1.json | 12 +- .../documents/vision.v1p1beta1.json | 12 +- .../documents/vision.v1p2beta1.json | 12 +- .../documents/workflowexecutions.v1.json | 8 +- 229 files changed, 12956 insertions(+), 1085 deletions(-) create mode 100644 docs/dyn/checks_v1alpha.accounts.repos.html create mode 100644 docs/dyn/checks_v1alpha.accounts.repos.operations.html create mode 100644 docs/dyn/compute_alpha.reservationBlocks.html create mode 100644 docs/dyn/drive_v3.operation.html create mode 100644 docs/dyn/drive_v3.operations.html create mode 100644 docs/dyn/networksecurity_v1beta1.projects.locations.mirroringDeploymentGroups.html create mode 100644 docs/dyn/networksecurity_v1beta1.projects.locations.mirroringDeployments.html create mode 100644 docs/dyn/networksecurity_v1beta1.projects.locations.mirroringEndpointGroupAssociations.html create mode 100644 docs/dyn/networksecurity_v1beta1.projects.locations.mirroringEndpointGroups.html diff --git a/docs/dyn/admin_directory_v1.customer.devices.chromeos.html b/docs/dyn/admin_directory_v1.customer.devices.chromeos.html index 1ed093d2268..fd5838ef993 100644 --- a/docs/dyn/admin_directory_v1.customer.devices.chromeos.html +++ b/docs/dyn/admin_directory_v1.customer.devices.chromeos.html @@ -151,7 +151,7 @@

Method Details

{ # A request for issuing a command. "commandType": "A String", # The type of command. - "payload": "A String", # The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { "volume": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { "ackedUserPresence": true }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. * `REBOOT`: Payload is a stringified JSON object in the form: { "user_session_delay_seconds": 300 }. The delay has to be in the range [0, 300]. * `FETCH_SUPPORT_PACKET`: Payload is optionally a stringified JSON object in the form: {"supportPacketDetails":{ "issueCaseId": optional_support_case_id_string, "issueDescription": optional_issue_description_string, "requestedDataCollectors": []}} The list of available `data_collector_enums` are as following: Chrome System Information (1), Crash IDs (2), Memory Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9), Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12), ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14), Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS Virtual Keyboard (22), ChromeOS Network Health (23). See more details in [help article](https://support.google.com/chrome/a?p=remote-log). + "payload": "A String", # The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { "volume": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { "ackedUserPresence": true, "crdSessionType": string }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. `crdSessionType` can only select from values `private` (which grants the remote admin exclusive control of the ChromeOS device) or `shared` (which allows the admin and the local user to share control of the ChromeOS device). If not set, `crdSessionType` defaults to `shared`. * `REBOOT`: Payload is a stringified JSON object in the form: { "user_session_delay_seconds": 300 }. The `user_session_delay_seconds` is the amount of seconds to wait before rebooting the device if a user is logged in. It has to be an integer in the range [0,300]. When payload is not present for reboot, 0 delay is the default. Note: This only applies if an actual user is logged in, including a Guest. If the device is in the login screen or in Kiosk mode the value is not respected and the device immediately reboots. * `FETCH_SUPPORT_PACKET`: Payload is optionally a stringified JSON object in the form: {"supportPacketDetails":{ "issueCaseId": optional_support_case_id_string, "issueDescription": optional_issue_description_string, "requestedDataCollectors": []}} The list of available `data_collector_enums` are as following: Chrome System Information (1), Crash IDs (2), Memory Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9), Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12), ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14), Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS Virtual Keyboard (22), ChromeOS Network Health (23). See more details in [help article](https://support.google.com/chrome/a?p=remote-log). } x__xgafv: string, V1 error format. diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index e7d68d5f48a..54dd2f30444 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -121,7 +121,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -194,7 +194,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -231,7 +231,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -254,7 +254,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -351,7 +379,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -375,7 +403,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -441,7 +469,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -472,7 +500,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -572,7 +628,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -658,7 +714,7 @@

Method Details

"usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } @@ -689,7 +745,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -713,7 +769,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -779,7 +835,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -810,7 +866,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -910,7 +994,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -996,7 +1080,7 @@

Method Details

"usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.annotations.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.annotations.html index a4b2bcbf4f2..d75ed2a34e9 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.annotations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.dataItems.annotations.html @@ -84,7 +84,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists Annotations belongs to a dataitem

+

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

list_next()

Retrieves the next page of results.

@@ -96,7 +96,7 @@

Method Details

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) -
Lists Annotations belongs to a dataitem
+  
Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.
 
 Args:
   parent: string, Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}` (required)
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
index 94540bf191a..9cf1be8300a 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
@@ -174,7 +174,7 @@ 

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -247,7 +247,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -284,7 +284,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -307,7 +307,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -1231,7 +1259,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1255,7 +1283,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -1321,7 +1349,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1352,7 +1380,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -1452,7 +1508,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1538,7 +1594,7 @@

Method Details

"usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, }
@@ -2882,7 +2938,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -2906,7 +2962,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -2972,7 +3028,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -3003,7 +3059,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -3103,7 +3187,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -3189,7 +3273,7 @@

Method Details

"usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.html b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.html index 084ee6740ac..78cff49fce3 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.html @@ -125,9 +125,11 @@

Method Details

"bigQuerySource": { # The BigQuery location for the input content. # Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. }, + "dense": True or False, # Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores. "entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "staticDataSource": True or False, # Optional. Set if the data source is not a time-series. "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary. "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest `feature_values` for each entity. Optional. If not provided, column named `feature_timestamp` of type `TIMESTAMP` will be used. }, @@ -227,9 +229,11 @@

Method Details

"bigQuerySource": { # The BigQuery location for the input content. # Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. }, + "dense": True or False, # Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores. "entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "staticDataSource": True or False, # Optional. Set if the data source is not a time-series. "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary. "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest `feature_values` for each entity. Optional. If not provided, column named `feature_timestamp` of type `TIMESTAMP` will be used. }, @@ -270,9 +274,11 @@

Method Details

"bigQuerySource": { # The BigQuery location for the input content. # Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. }, + "dense": True or False, # Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores. "entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "staticDataSource": True or False, # Optional. Set if the data source is not a time-series. "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary. "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest `feature_values` for each entity. Optional. If not provided, column named `feature_timestamp` of type `TIMESTAMP` will be used. }, @@ -319,9 +325,11 @@

Method Details

"bigQuerySource": { # The BigQuery location for the input content. # Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. }, + "dense": True or False, # Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores. "entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "staticDataSource": True or False, # Optional. Set if the data source is not a time-series. "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary. "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest `feature_values` for each entity. Optional. If not provided, column named `feature_timestamp` of type `TIMESTAMP` will be used. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html index 9ca0b62a79c..0e4e930bf35 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html @@ -99,6 +99,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single FeatureView.

+

+ 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, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists FeatureViews in a given FeatureOnlineStore.

@@ -111,9 +114,15 @@

Instance Methods

searchNearestEntities(featureView, body=None, x__xgafv=None)

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

+

+ 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.

sync(featureView, body=None, x__xgafv=None)

Triggers on-demand sync for the FeatureView.

+

+ testIamPermissions(resource, permissions=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() @@ -173,6 +182,10 @@

Method Details

"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. + "vertexRagSource": { # A Vertex Rag source for features that need to be synced to Online Store. # Optional. The Vertex RAG Source that the FeatureView is linked to. + "ragCorpusId": "A String", # Optional. The RAG corpus id corresponding to this FeatureView. + "uri": "A String", # Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE + }, } featureViewId: string, Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. @@ -388,6 +401,45 @@

Method Details

"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. + "vertexRagSource": { # A Vertex Rag source for features that need to be synced to Online Store. # Optional. The Vertex RAG Source that the FeatureView is linked to. + "ragCorpusId": "A String", # Optional. The RAG corpus id corresponding to this FeatureView. + "uri": "A String", # Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE + }, +} +
+ +
+ 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/).
+  "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).
 }
@@ -455,6 +507,10 @@

Method Details

"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. + "vertexRagSource": { # A Vertex Rag source for features that need to be synced to Online Store. # Optional. The Vertex RAG Source that the FeatureView is linked to. + "ragCorpusId": "A String", # Optional. The RAG corpus id corresponding to this FeatureView. + "uri": "A String", # Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE + }, }, ], "nextPageToken": "A String", # A token, which can be sent as ListFeatureViewsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -528,6 +584,10 @@

Method Details

"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, "updateTime": "A String", # Output only. Timestamp when this FeatureView was last updated. + "vertexRagSource": { # A Vertex Rag source for features that need to be synced to Online Store. # Optional. The Vertex RAG Source that the FeatureView is linked to. + "ragCorpusId": "A String", # Optional. The RAG corpus id corresponding to this FeatureView. + "uri": "A String", # Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE + }, } updateMask: string, Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` @@ -685,6 +745,64 @@

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.
+    "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).
+}
+
+
sync(featureView, body=None, x__xgafv=None)
Triggers on-demand sync for the FeatureView.
@@ -705,9 +823,31 @@ 

Method Details

Returns: An object of the form: - { # Respose message for FeatureOnlineStoreAdminService.SyncFeatureView. + { # Response message for FeatureOnlineStoreAdminService.SyncFeatureView. "featureViewSync": "A String", # Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` }
+
+ testIamPermissions(resource, permissions=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)
+  permissions: string, 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). (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `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/aiplatform_v1.projects.locations.featureOnlineStores.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html index f2c3c15ea8d..e33c1343f1d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html @@ -96,6 +96,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single FeatureOnlineStore.

+

+ 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, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists FeatureOnlineStores in a given project and location.

@@ -105,6 +108,12 @@

Instance Methods

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

Updates the parameters of a single FeatureOnlineStore.

+

+ 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, permissions=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() @@ -273,6 +282,41 @@

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/).
+  "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, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists FeatureOnlineStores in a given project and location.
@@ -422,4 +466,84 @@ 

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.
+    "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, permissions=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)
+  permissions: string, 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). (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `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/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 694af0e3b64..4a0a3433e0b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -133,7 +133,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -206,7 +206,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -243,7 +243,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -266,7 +266,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -363,7 +391,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -387,7 +415,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -453,7 +481,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -484,7 +512,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -584,7 +640,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -670,7 +726,7 @@

Method Details

"usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } @@ -965,7 +1021,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -989,7 +1045,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -1055,7 +1111,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1086,7 +1142,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -1186,7 +1270,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1272,7 +1356,7 @@

Method Details

"usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index 50693f846d1..b20c2c3dd6b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -201,7 +201,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -348,7 +348,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -502,7 +502,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -662,7 +662,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 4041c25b240..cd9230b2ff3 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -124,7 +124,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -197,7 +197,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -234,7 +234,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -257,7 +257,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -354,7 +382,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -378,7 +406,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -444,7 +472,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -475,7 +503,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -575,7 +631,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -661,7 +717,7 @@

Method Details

"usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } @@ -1085,7 +1141,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1109,7 +1165,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -1175,7 +1231,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1206,7 +1262,35 @@

Method Details

{ # 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 + "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-object). 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. + }, + "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-object). 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"]} @@ -1306,7 +1390,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1392,7 +1476,7 @@

Method Details

"usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 740c3a28ffc..4a4222bee39 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -121,7 +121,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -194,7 +194,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -231,7 +231,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -254,7 +254,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -282,7 +282,7 @@

Method Details

"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. + "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-object). 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"]} @@ -380,7 +380,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -404,7 +404,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -470,7 +470,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -501,7 +501,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -529,7 +529,7 @@

Method Details

"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. + "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-object). 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"]} @@ -629,7 +629,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -716,9 +716,10 @@

Method Details

], }, "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). + "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } @@ -750,7 +751,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -774,7 +775,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -840,7 +841,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -871,7 +872,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -899,7 +900,7 @@

Method Details

"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. + "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-object). 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"]} @@ -999,7 +1000,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1086,9 +1087,10 @@

Method Details

], }, "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). + "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } diff --git a/docs/dyn/aiplatform_v1beta1.media.html b/docs/dyn/aiplatform_v1beta1.media.html index 6eeaeafdb35..997fe57ade7 100644 --- a/docs/dyn/aiplatform_v1beta1.media.html +++ b/docs/dyn/aiplatform_v1beta1.media.html @@ -102,6 +102,10 @@

Method Details

"directUploadSource": { # The input content is encapsulated and uploaded in the request. # Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request. }, "displayName": "A String", # Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "fileStatus": { # RagFile status. # Output only. State of the RagFile. + "errorStatus": "A String", # Output only. Only when the `state` field is ERROR. + "state": "A String", # Output only. RagFile state. + }, "gcsSource": { # The Google Cloud Storage location for the input content. # Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now. "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. "A String", @@ -187,6 +191,10 @@

Method Details

"directUploadSource": { # The input content is encapsulated and uploaded in the request. # Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request. }, "displayName": "A String", # Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "fileStatus": { # RagFile status. # Output only. State of the RagFile. + "errorStatus": "A String", # Output only. Only when the `state` field is ERROR. + "state": "A String", # Output only. RagFile state. + }, "gcsSource": { # The Google Cloud Storage location for the input content. # Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now. "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. "A String", diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index a4fe87289aa..72611272718 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -127,7 +127,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -165,7 +165,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -196,7 +196,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -224,7 +224,7 @@

Method Details

"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. + "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-object). 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"]} @@ -281,6 +281,13 @@

Method Details

], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. When the cache entry was last updated in UTC time. + "usageMetadata": { # Metadata on the usage of the cached content. # Output only. Metadata on the usage of the cached content. + "audioDurationSeconds": 42, # Duration of audio in seconds. + "imageCount": 42, # Number of images. + "textCount": 42, # Number of text characters. + "totalTokenCount": 42, # Total number of tokens that the cached content consumes. + "videoDurationSeconds": 42, # Duration of video in seconds. + }, } x__xgafv: string, V1 error format. @@ -308,7 +315,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -346,7 +353,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -377,7 +384,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -405,7 +412,7 @@

Method Details

"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. + "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-object). 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"]} @@ -462,6 +469,13 @@

Method Details

], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. When the cache entry was last updated in UTC time. + "usageMetadata": { # Metadata on the usage of the cached content. # Output only. Metadata on the usage of the cached content. + "audioDurationSeconds": 42, # Duration of audio in seconds. + "imageCount": 42, # Number of images. + "textCount": 42, # Number of text characters. + "totalTokenCount": 42, # Total number of tokens that the cached content consumes. + "videoDurationSeconds": 42, # Duration of video in seconds. + }, } @@ -514,7 +528,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -552,7 +566,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -583,7 +597,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -611,7 +625,7 @@

Method Details

"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. + "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-object). 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"]} @@ -668,6 +682,13 @@

Method Details

], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. When the cache entry was last updated in UTC time. + "usageMetadata": { # Metadata on the usage of the cached content. # Output only. Metadata on the usage of the cached content. + "audioDurationSeconds": 42, # Duration of audio in seconds. + "imageCount": 42, # Number of images. + "textCount": 42, # Number of text characters. + "totalTokenCount": 42, # Total number of tokens that the cached content consumes. + "videoDurationSeconds": 42, # Duration of video in seconds. + }, } @@ -706,7 +727,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -744,7 +765,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -775,7 +796,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -803,7 +824,7 @@

Method Details

"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. + "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-object). 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"]} @@ -860,6 +881,13 @@

Method Details

], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. When the cache entry was last updated in UTC time. + "usageMetadata": { # Metadata on the usage of the cached content. # Output only. Metadata on the usage of the cached content. + "audioDurationSeconds": 42, # Duration of audio in seconds. + "imageCount": 42, # Number of images. + "textCount": 42, # Number of text characters. + "totalTokenCount": 42, # Total number of tokens that the cached content consumes. + "videoDurationSeconds": 42, # Duration of video in seconds. + }, }, ], "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. @@ -906,7 +934,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -944,7 +972,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -975,7 +1003,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -1003,7 +1031,7 @@

Method Details

"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. + "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-object). 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"]} @@ -1060,6 +1088,13 @@

Method Details

], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. When the cache entry was last updated in UTC time. + "usageMetadata": { # Metadata on the usage of the cached content. # Output only. Metadata on the usage of the cached content. + "audioDurationSeconds": 42, # Duration of audio in seconds. + "imageCount": 42, # Number of images. + "textCount": 42, # Number of text characters. + "totalTokenCount": 42, # Total number of tokens that the cached content consumes. + "videoDurationSeconds": 42, # Duration of video in seconds. + }, } updateMask: string, Required. The list of fields to update. @@ -1088,7 +1123,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1126,7 +1161,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1157,7 +1192,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -1185,7 +1220,7 @@

Method Details

"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. + "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-object). 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"]} @@ -1242,6 +1277,13 @@

Method Details

], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. When the cache entry was last updated in UTC time. + "usageMetadata": { # Metadata on the usage of the cached content. # Output only. Metadata on the usage of the cached content. + "audioDurationSeconds": 42, # Duration of audio in seconds. + "imageCount": 42, # Number of images. + "textCount": 42, # Number of text characters. + "totalTokenCount": 42, # Total number of tokens that the cached content consumes. + "videoDurationSeconds": 42, # Duration of video in seconds. + }, } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.annotations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.annotations.html index 739448b3a7f..145f1724dbd 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.annotations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.dataItems.annotations.html @@ -84,7 +84,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists Annotations belongs to a dataitem

+

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

list_next()

Retrieves the next page of results.

@@ -96,7 +96,7 @@

Method Details

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) -
Lists Annotations belongs to a dataitem
+  
Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.
 
 Args:
   parent: string, Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}` (required)
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
index 77993b27587..6057981dcb5 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
@@ -188,7 +188,7 @@ 

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -261,7 +261,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -298,7 +298,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -321,7 +321,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -349,7 +349,7 @@

Method Details

"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. + "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-object). 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"]} @@ -1412,7 +1412,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1436,7 +1436,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -1502,7 +1502,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1533,7 +1533,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -1561,7 +1561,7 @@

Method Details

"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. + "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-object). 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"]} @@ -1661,7 +1661,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1748,9 +1748,10 @@

Method Details

], }, "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). + "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, }
@@ -3212,7 +3213,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -3236,7 +3237,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -3302,7 +3303,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -3333,7 +3334,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -3361,7 +3362,7 @@

Method Details

"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. + "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-object). 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"]} @@ -3461,7 +3462,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -3548,9 +3549,10 @@

Method Details

], }, "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). + "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index 63c38d9b0d1..a0d86f14824 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -222,7 +222,7 @@

Method Details

"functionDeclaration": { # 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. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec. "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 + "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-object). 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"]} @@ -250,7 +250,7 @@

Method Details

"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. + "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-object). 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"]} @@ -370,7 +370,7 @@

Method Details

"functionDeclaration": { # 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. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec. "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 + "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-object). 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"]} @@ -398,7 +398,7 @@

Method Details

"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. + "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-object). 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"]} @@ -557,7 +557,7 @@

Method Details

"functionDeclaration": { # 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. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec. "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 + "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-object). 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"]} @@ -585,7 +585,7 @@

Method Details

"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. + "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-object). 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"]} @@ -722,7 +722,7 @@

Method Details

"functionDeclaration": { # 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. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec. "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 + "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-object). 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"]} @@ -750,7 +750,7 @@

Method Details

"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. + "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-object). 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"]} @@ -869,7 +869,7 @@

Method Details

"functionDeclaration": { # 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. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec. "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 + "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-object). 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"]} @@ -897,7 +897,7 @@

Method Details

"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. + "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-object). 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"]} @@ -1024,7 +1024,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1070,7 +1070,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html index fff59bfe2be..ada61106cdf 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html @@ -125,9 +125,11 @@

Method Details

"bigQuerySource": { # The BigQuery location for the input content. # Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. }, + "dense": True or False, # Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores. "entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "staticDataSource": True or False, # Optional. Set if the data source is not a time-series. "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary. "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest `feature_values` for each entity. Optional. If not provided, column named `feature_timestamp` of type `TIMESTAMP` will be used. }, @@ -227,9 +229,11 @@

Method Details

"bigQuerySource": { # The BigQuery location for the input content. # Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. }, + "dense": True or False, # Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores. "entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "staticDataSource": True or False, # Optional. Set if the data source is not a time-series. "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary. "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest `feature_values` for each entity. Optional. If not provided, column named `feature_timestamp` of type `TIMESTAMP` will be used. }, @@ -270,9 +274,11 @@

Method Details

"bigQuerySource": { # The BigQuery location for the input content. # Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. }, + "dense": True or False, # Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores. "entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "staticDataSource": True or False, # Optional. Set if the data source is not a time-series. "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary. "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest `feature_values` for each entity. Optional. If not provided, column named `feature_timestamp` of type `TIMESTAMP` will be used. }, @@ -319,9 +325,11 @@

Method Details

"bigQuerySource": { # The BigQuery location for the input content. # Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. }, + "dense": True or False, # Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores. "entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "staticDataSource": True or False, # Optional. Set if the data source is not a time-series. "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary. "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest `feature_values` for each entity. Optional. If not provided, column named `feature_timestamp` of type `TIMESTAMP` will be used. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html index c3bba5ea59c..5b430b1279c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html @@ -201,6 +201,10 @@

Method Details

"leafNodeEmbeddingCount": "A String", # Optional. Number of embeddings on each leaf node. The default value is 1000 if not set. }, }, + "vertexRagSource": { # A Vertex Rag source for features that need to be synced to Online Store. # Optional. The Vertex RAG Source that the FeatureView is linked to. + "ragCorpusId": "A String", # Optional. The RAG corpus id corresponding to this FeatureView. + "uri": "A String", # Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE + }, } featureViewId: string, Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. @@ -434,6 +438,10 @@

Method Details

"leafNodeEmbeddingCount": "A String", # Optional. Number of embeddings on each leaf node. The default value is 1000 if not set. }, }, + "vertexRagSource": { # A Vertex Rag source for features that need to be synced to Online Store. # Optional. The Vertex RAG Source that the FeatureView is linked to. + "ragCorpusId": "A String", # Optional. The RAG corpus id corresponding to this FeatureView. + "uri": "A String", # Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE + }, } @@ -552,6 +560,10 @@

Method Details

"leafNodeEmbeddingCount": "A String", # Optional. Number of embeddings on each leaf node. The default value is 1000 if not set. }, }, + "vertexRagSource": { # A Vertex Rag source for features that need to be synced to Online Store. # Optional. The Vertex RAG Source that the FeatureView is linked to. + "ragCorpusId": "A String", # Optional. The RAG corpus id corresponding to this FeatureView. + "uri": "A String", # Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE + }, }, ], "nextPageToken": "A String", # A token, which can be sent as ListFeatureViewsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -641,6 +653,10 @@

Method Details

"leafNodeEmbeddingCount": "A String", # Optional. Number of embeddings on each leaf node. The default value is 1000 if not set. }, }, + "vertexRagSource": { # A Vertex Rag source for features that need to be synced to Online Store. # Optional. The Vertex RAG Source that the FeatureView is linked to. + "ragCorpusId": "A String", # Optional. The RAG corpus id corresponding to this FeatureView. + "uri": "A String", # Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE + }, } updateMask: string, Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` @@ -990,7 +1006,7 @@

Method Details

Returns: An object of the form: - { # Respose message for FeatureOnlineStoreAdminService.SyncFeatureView. + { # Response message for FeatureOnlineStoreAdminService.SyncFeatureView. "featureViewSync": "A String", # Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 8580bf0927c..8f77c92d7fd 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -136,7 +136,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -209,7 +209,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -246,7 +246,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -269,7 +269,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -297,7 +297,7 @@

Method Details

"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. + "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-object). 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"]} @@ -395,7 +395,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -419,7 +419,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -485,7 +485,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -516,7 +516,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -544,7 +544,7 @@

Method Details

"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. + "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-object). 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"]} @@ -644,7 +644,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -731,9 +731,10 @@

Method Details

], }, "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). + "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } @@ -1064,7 +1065,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1088,7 +1089,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -1154,7 +1155,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1185,7 +1186,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -1213,7 +1214,7 @@

Method Details

"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. + "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-object). 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"]} @@ -1313,7 +1314,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1400,9 +1401,10 @@

Method Details

], }, "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). + "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html index e4731a53370..79d6e3285da 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html @@ -102,6 +102,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Updates a RagCorpus.

Method Details

close() @@ -118,6 +121,10 @@

Method Details

The object takes the form of: { # A RagCorpus is a RagFile container and a project can have multiple RagCorpora. + "corpusStatus": { # RagCorpus status. # Output only. RagCorpus state. + "errorStatus": "A String", # Output only. Only when the `state` field is ERROR. + "state": "A String", # Output only. RagCorpus life state. + }, "createTime": "A String", # Output only. Timestamp when this RagCorpus was created. "description": "A String", # Optional. The description of the RagCorpus. "displayName": "A String", # Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -143,6 +150,22 @@

Method Details

"modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. }, }, + "ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus. + "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "ragManagedDb": { # The config for the default RAG-managed Vector DB. # The config for the RAG-managed Vector DB. + }, + "vertexFeatureStore": { # The config for the Vertex Feature Store. # The config for the Vertex Feature Store. + "featureViewResourceName": "A String", # The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + }, + "weaviate": { # The config for the Weaviate. # The config for the Weaviate. + "collectionName": "A String", # The corresponding collection this corpus maps to. This value cannot be changed after it's set. + "httpEndpoint": "A String", # Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set. + }, + }, "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated. } @@ -226,6 +249,10 @@

Method Details

An object of the form: { # A RagCorpus is a RagFile container and a project can have multiple RagCorpora. + "corpusStatus": { # RagCorpus status. # Output only. RagCorpus state. + "errorStatus": "A String", # Output only. Only when the `state` field is ERROR. + "state": "A String", # Output only. RagCorpus life state. + }, "createTime": "A String", # Output only. Timestamp when this RagCorpus was created. "description": "A String", # Optional. The description of the RagCorpus. "displayName": "A String", # Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -251,6 +278,22 @@

Method Details

"modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. }, }, + "ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus. + "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "ragManagedDb": { # The config for the default RAG-managed Vector DB. # The config for the RAG-managed Vector DB. + }, + "vertexFeatureStore": { # The config for the Vertex Feature Store. # The config for the Vertex Feature Store. + "featureViewResourceName": "A String", # The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + }, + "weaviate": { # The config for the Weaviate. # The config for the Weaviate. + "collectionName": "A String", # The corresponding collection this corpus maps to. This value cannot be changed after it's set. + "httpEndpoint": "A String", # Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set. + }, + }, "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated. }
@@ -275,6 +318,10 @@

Method Details

"nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page. "ragCorpora": [ # List of RagCorpora in the requested page. { # A RagCorpus is a RagFile container and a project can have multiple RagCorpora. + "corpusStatus": { # RagCorpus status. # Output only. RagCorpus state. + "errorStatus": "A String", # Output only. Only when the `state` field is ERROR. + "state": "A String", # Output only. RagCorpus life state. + }, "createTime": "A String", # Output only. Timestamp when this RagCorpus was created. "description": "A String", # Optional. The description of the RagCorpus. "displayName": "A String", # Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -300,6 +347,22 @@

Method Details

"modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. }, }, + "ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus. + "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + }, + "ragManagedDb": { # The config for the default RAG-managed Vector DB. # The config for the RAG-managed Vector DB. + }, + "vertexFeatureStore": { # The config for the Vertex Feature Store. # The config for the Vertex Feature Store. + "featureViewResourceName": "A String", # The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + }, + "weaviate": { # The config for the Weaviate. # The config for the Weaviate. + "collectionName": "A String", # The corresponding collection this corpus maps to. This value cannot be changed after it's set. + "httpEndpoint": "A String", # Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set. + }, + }, "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated. }, ], @@ -320,4 +383,91 @@

Method Details

+
+ patch(name, body=None, x__xgafv=None) +
Updates a RagCorpus.
+
+Args:
+  name: string, Output only. The resource name of the RagCorpus. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A RagCorpus is a RagFile container and a project can have multiple RagCorpora.
+  "corpusStatus": { # RagCorpus status. # Output only. RagCorpus state.
+    "errorStatus": "A String", # Output only. Only when the `state` field is ERROR.
+    "state": "A String", # Output only. RagCorpus life state.
+  },
+  "createTime": "A String", # Output only. Timestamp when this RagCorpus was created.
+  "description": "A String", # Optional. The description of the RagCorpus.
+  "displayName": "A String", # Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "name": "A String", # Output only. The resource name of the RagCorpus.
+  "ragEmbeddingModelConfig": { # Config for the embedding model to use for RAG. # Optional. Immutable. The embedding model config of the RagCorpus.
+    "hybridSearchConfig": { # Config for hybrid search. # Configuration for hybrid search.
+      "denseEmbeddingModelPredictionEndpoint": { # Config representing a model hosted on Vertex Prediction Endpoint. # Required. The Vertex AI Prediction Endpoint that hosts the embedding model for dense embedding generations.
+        "endpoint": "A String", # Required. The endpoint resource name. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/endpoints/{endpoint}`
+        "model": "A String", # Output only. The resource name of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. Pattern: `projects/{project}/locations/{location}/models/{model}`
+        "modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.
+      },
+      "sparseEmbeddingConfig": { # Configuration for sparse emebdding generation. # Optional. The configuration for sparse embedding generation. This field is optional the default behavior depends on the vector database choice on the RagCorpus.
+        "bm25": { # Message for BM25 parameters. # Use BM25 scoring algorithm.
+          "b": 3.14, # Optional. The parameter to control document length normalization. It determines how much the document length affects the final score. b is in the range of [0, 1]. The default value is 0.75.
+          "k1": 3.14, # Optional. The parameter to control term frequency saturation. It determines the scaling between the matching term frequency and final score. k1 is in the range of [1.2, 3]. The default value is 1.2.
+          "multilingual": True or False, # Optional. Use multilingual tokenizer if set to true.
+        },
+      },
+    },
+    "vertexPredictionEndpoint": { # Config representing a model hosted on Vertex Prediction Endpoint. # The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. This is used for dense vector search.
+      "endpoint": "A String", # Required. The endpoint resource name. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/endpoints/{endpoint}`
+      "model": "A String", # Output only. The resource name of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. Pattern: `projects/{project}/locations/{location}/models/{model}`
+      "modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.
+    },
+  },
+  "ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus.
+    "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+      "apiKeyConfig": { # The API secret. # The API secret.
+        "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+      },
+    },
+    "ragManagedDb": { # The config for the default RAG-managed Vector DB. # The config for the RAG-managed Vector DB.
+    },
+    "vertexFeatureStore": { # The config for the Vertex Feature Store. # The config for the Vertex Feature Store.
+      "featureViewResourceName": "A String", # The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
+    },
+    "weaviate": { # The config for the Weaviate. # The config for the Weaviate.
+      "collectionName": "A String", # The corresponding collection this corpus maps to. This value cannot be changed after it's set.
+      "httpEndpoint": "A String", # Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set.
+    },
+  },
+  "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html index fb066e5109c..96f75a41b69 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html @@ -158,6 +158,10 @@

Method Details

"directUploadSource": { # The input content is encapsulated and uploaded in the request. # Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request. }, "displayName": "A String", # Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "fileStatus": { # RagFile status. # Output only. State of the RagFile. + "errorStatus": "A String", # Output only. Only when the `state` field is ERROR. + "state": "A String", # Output only. RagFile state. + }, "gcsSource": { # The Google Cloud Storage location for the input content. # Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now. "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. "A String", @@ -333,6 +337,10 @@

Method Details

"directUploadSource": { # The input content is encapsulated and uploaded in the request. # Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request. }, "displayName": "A String", # Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters. + "fileStatus": { # RagFile status. # Output only. State of the RagFile. + "errorStatus": "A String", # Output only. Only when the `state` field is ERROR. + "state": "A String", # Output only. RagFile state. + }, "gcsSource": { # The Google Cloud Storage location for the input content. # Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now. "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. "A String", diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index f7922b55d55..cd79aea24a7 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -206,7 +206,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -300,7 +300,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -457,7 +457,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -551,7 +551,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -715,7 +715,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -809,7 +809,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -979,7 +979,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1073,7 +1073,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 5246b7c854e..e76153e64f8 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -130,7 +130,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -203,7 +203,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -240,7 +240,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -263,7 +263,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -291,7 +291,7 @@

Method Details

"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. + "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-object). 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"]} @@ -389,7 +389,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -413,7 +413,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -479,7 +479,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -510,7 +510,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -538,7 +538,7 @@

Method Details

"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. + "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-object). 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"]} @@ -638,7 +638,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -725,9 +725,10 @@

Method Details

], }, "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). + "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } @@ -1584,7 +1585,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1608,7 +1609,7 @@

Method Details

"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseSchema": { # 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. 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. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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. "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"]} @@ -1674,7 +1675,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1705,7 +1706,7 @@

Method Details

{ # 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 + "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-object). 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"]} @@ -1733,7 +1734,7 @@

Method Details

"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. + "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-object). 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"]} @@ -1833,7 +1834,7 @@

Method Details

}, "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. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, @@ -1920,9 +1921,10 @@

Method Details

], }, "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). + "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). "candidatesTokenCount": 42, # Number of tokens in the response(s). "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "totalTokenCount": 42, + "totalTokenCount": 42, # Total token count for prompt and response candidates. }, } diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.html b/docs/dyn/alloydb_v1.projects.locations.clusters.html index c2b8dc17b5d..0002dbf72ad 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.html @@ -117,6 +117,9 @@

Instance Methods

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

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

+

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

+

Upgrades a single Cluster. Imperative only.

Method Details

close() @@ -1301,4 +1304,49 @@

Method Details

}
+
+ upgrade(name, body=None, x__xgafv=None) +
Upgrades a single Cluster. Imperative only.
+
+Args:
+  name: string, Required. The resource name of the cluster. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Upgrades a cluster.
+  "etag": "A String", # Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  "validateOnly": True or False, # Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.
+  "version": "A String", # Required. The version the cluster is going to be upgraded to.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html index 52deac2a5d3..f6e69b48140 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html @@ -160,6 +160,7 @@

Method Details

"cidrRange": "A String", # CIDR range for one authorzied network of the instance. }, ], + "enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet. "enablePublicIp": True or False, # Optional. Enabling public ip for the instance. }, "nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. @@ -170,6 +171,9 @@

Method Details

"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b". }, ], + "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. + "A String", + ], "pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance. "allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. "A String", @@ -276,6 +280,7 @@

Method Details

"cidrRange": "A String", # CIDR range for one authorzied network of the instance. }, ], + "enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet. "enablePublicIp": True or False, # Optional. Enabling public ip for the instance. }, "nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. @@ -286,6 +291,9 @@

Method Details

"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b". }, ], + "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. + "A String", + ], "pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance. "allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. "A String", @@ -483,6 +491,7 @@

Method Details

"cidrRange": "A String", # CIDR range for one authorzied network of the instance. }, ], + "enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet. "enablePublicIp": True or False, # Optional. Enabling public ip for the instance. }, "nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. @@ -493,6 +502,9 @@

Method Details

"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b". }, ], + "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. + "A String", + ], "pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance. "allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. "A String", @@ -646,6 +658,7 @@

Method Details

"cidrRange": "A String", # CIDR range for one authorzied network of the instance. }, ], + "enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet. "enablePublicIp": True or False, # Optional. Enabling public ip for the instance. }, "nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. @@ -656,6 +669,9 @@

Method Details

"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b". }, ], + "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. + "A String", + ], "pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance. "allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. "A String", @@ -751,6 +767,7 @@

Method Details

"cidrRange": "A String", # CIDR range for one authorzied network of the instance. }, ], + "enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet. "enablePublicIp": True or False, # Optional. Enabling public ip for the instance. }, "nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. @@ -761,6 +778,9 @@

Method Details

"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b". }, ], + "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. + "A String", + ], "pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance. "allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. "A String", diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html index ed6f597b556..6d890060b0b 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html @@ -117,6 +117,9 @@

Instance Methods

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

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

+

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

+

Upgrades a single Cluster. Imperative only.

Method Details

close() @@ -1349,4 +1352,49 @@

Method Details

}
+
+ upgrade(name, body=None, x__xgafv=None) +
Upgrades a single Cluster. Imperative only.
+
+Args:
+  name: string, Required. The resource name of the cluster. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Upgrades a cluster.
+  "etag": "A String", # Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  "validateOnly": True or False, # Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.
+  "version": "A String", # Required. The version the cluster is going to be upgraded to.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index dd43ee9f45a..218d5976bb4 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -138,6 +138,7 @@

Method Details

"adjustVolumeDisabled": True or False, # Whether adjusting the master volume is disabled. Also mutes the device. "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Advanced security settings. In most cases, setting these is not needed. "commonCriteriaMode": "A String", # Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Common Criteria Mode is only supported on company-owned devices running Android 11 or above.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. + "contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. @@ -205,6 +206,7 @@

Method Details

"workProfileWidgets": "A String", # Specifies whether the app installed in the work profile is allowed to add widgets to the home screen. }, ], + "assistContentPolicy": "A String", # Optional. Controls whether AssistContent (https://developer.android.com/reference/android/app/assist/AssistContent) is allowed to be sent to a privileged app such as an assistant app. AssistContent includes screenshots and information about an app, such as package name. This is supported on Android 15 and above. "autoDateAndTimeZone": "A String", # Whether auto date, time, and time zone are enabled on a company-owned device. If this is set, then autoTimeRequired is ignored. "autoTimeRequired": True or False, # Whether auto time is required, which prevents the user from manually setting the date and time. If autoDateAndTimeZone is set, this field is ignored. "blockApplicationsEnabled": True or False, # Whether applications other than the ones configured in applications are blocked from being installed. When set, applications that were installed under a previous policy but no longer appear in the policy are automatically uninstalled. @@ -537,7 +539,7 @@

Method Details

"version": "A String", # The version of the policy. This is a read-only field. The version is incremented each time the policy is updated. "vpnConfigDisabled": True or False, # Whether configuring VPN is disabled. "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi networks is disabled. Supported on fully managed devices and work profiles on company-owned devices. For fully managed devices, setting this to true removes all configured networks and retains only the networks configured using openNetworkConfiguration. For work profiles on company-owned devices, existing configured networks are not affected and the user is not allowed to add, remove, or modify Wi-Fi networks. If configureWifi is set to anything other than CONFIGURE_WIFI_UNSPECIFIED, this setting is ignored. Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). - "wifiConfigsLockdownEnabled": True or False, # DEPRECATED - Use wifi_config_disabled. + "wifiConfigsLockdownEnabled": True or False, # This is deprecated. } @@ -568,6 +570,7 @@

Method Details

"adjustVolumeDisabled": True or False, # Whether adjusting the master volume is disabled. Also mutes the device. "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Advanced security settings. In most cases, setting these is not needed. "commonCriteriaMode": "A String", # Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Common Criteria Mode is only supported on company-owned devices running Android 11 or above.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. + "contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. @@ -635,6 +638,7 @@

Method Details

"workProfileWidgets": "A String", # Specifies whether the app installed in the work profile is allowed to add widgets to the home screen. }, ], + "assistContentPolicy": "A String", # Optional. Controls whether AssistContent (https://developer.android.com/reference/android/app/assist/AssistContent) is allowed to be sent to a privileged app such as an assistant app. AssistContent includes screenshots and information about an app, such as package name. This is supported on Android 15 and above. "autoDateAndTimeZone": "A String", # Whether auto date, time, and time zone are enabled on a company-owned device. If this is set, then autoTimeRequired is ignored. "autoTimeRequired": True or False, # Whether auto time is required, which prevents the user from manually setting the date and time. If autoDateAndTimeZone is set, this field is ignored. "blockApplicationsEnabled": True or False, # Whether applications other than the ones configured in applications are blocked from being installed. When set, applications that were installed under a previous policy but no longer appear in the policy are automatically uninstalled. @@ -967,7 +971,7 @@

Method Details

"version": "A String", # The version of the policy. This is a read-only field. The version is incremented each time the policy is updated. "vpnConfigDisabled": True or False, # Whether configuring VPN is disabled. "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi networks is disabled. Supported on fully managed devices and work profiles on company-owned devices. For fully managed devices, setting this to true removes all configured networks and retains only the networks configured using openNetworkConfiguration. For work profiles on company-owned devices, existing configured networks are not affected and the user is not allowed to add, remove, or modify Wi-Fi networks. If configureWifi is set to anything other than CONFIGURE_WIFI_UNSPECIFIED, this setting is ignored. Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). - "wifiConfigsLockdownEnabled": True or False, # DEPRECATED - Use wifi_config_disabled. + "wifiConfigsLockdownEnabled": True or False, # This is deprecated. }, ], } @@ -1004,6 +1008,7 @@

Method Details

"adjustVolumeDisabled": True or False, # Whether adjusting the master volume is disabled. Also mutes the device. "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Advanced security settings. In most cases, setting these is not needed. "commonCriteriaMode": "A String", # Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Common Criteria Mode is only supported on company-owned devices running Android 11 or above.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. + "contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. @@ -1071,6 +1076,7 @@

Method Details

"workProfileWidgets": "A String", # Specifies whether the app installed in the work profile is allowed to add widgets to the home screen. }, ], + "assistContentPolicy": "A String", # Optional. Controls whether AssistContent (https://developer.android.com/reference/android/app/assist/AssistContent) is allowed to be sent to a privileged app such as an assistant app. AssistContent includes screenshots and information about an app, such as package name. This is supported on Android 15 and above. "autoDateAndTimeZone": "A String", # Whether auto date, time, and time zone are enabled on a company-owned device. If this is set, then autoTimeRequired is ignored. "autoTimeRequired": True or False, # Whether auto time is required, which prevents the user from manually setting the date and time. If autoDateAndTimeZone is set, this field is ignored. "blockApplicationsEnabled": True or False, # Whether applications other than the ones configured in applications are blocked from being installed. When set, applications that were installed under a previous policy but no longer appear in the policy are automatically uninstalled. @@ -1403,7 +1409,7 @@

Method Details

"version": "A String", # The version of the policy. This is a read-only field. The version is incremented each time the policy is updated. "vpnConfigDisabled": True or False, # Whether configuring VPN is disabled. "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi networks is disabled. Supported on fully managed devices and work profiles on company-owned devices. For fully managed devices, setting this to true removes all configured networks and retains only the networks configured using openNetworkConfiguration. For work profiles on company-owned devices, existing configured networks are not affected and the user is not allowed to add, remove, or modify Wi-Fi networks. If configureWifi is set to anything other than CONFIGURE_WIFI_UNSPECIFIED, this setting is ignored. Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). - "wifiConfigsLockdownEnabled": True or False, # DEPRECATED - Use wifi_config_disabled. + "wifiConfigsLockdownEnabled": True or False, # This is deprecated. } updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified. @@ -1423,6 +1429,7 @@

Method Details

"adjustVolumeDisabled": True or False, # Whether adjusting the master volume is disabled. Also mutes the device. "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Advanced security settings. In most cases, setting these is not needed. "commonCriteriaMode": "A String", # Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Common Criteria Mode is only supported on company-owned devices running Android 11 or above.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. + "contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. @@ -1490,6 +1497,7 @@

Method Details

"workProfileWidgets": "A String", # Specifies whether the app installed in the work profile is allowed to add widgets to the home screen. }, ], + "assistContentPolicy": "A String", # Optional. Controls whether AssistContent (https://developer.android.com/reference/android/app/assist/AssistContent) is allowed to be sent to a privileged app such as an assistant app. AssistContent includes screenshots and information about an app, such as package name. This is supported on Android 15 and above. "autoDateAndTimeZone": "A String", # Whether auto date, time, and time zone are enabled on a company-owned device. If this is set, then autoTimeRequired is ignored. "autoTimeRequired": True or False, # Whether auto time is required, which prevents the user from manually setting the date and time. If autoDateAndTimeZone is set, this field is ignored. "blockApplicationsEnabled": True or False, # Whether applications other than the ones configured in applications are blocked from being installed. When set, applications that were installed under a previous policy but no longer appear in the policy are automatically uninstalled. @@ -1822,7 +1830,7 @@

Method Details

"version": "A String", # The version of the policy. This is a read-only field. The version is incremented each time the policy is updated. "vpnConfigDisabled": True or False, # Whether configuring VPN is disabled. "wifiConfigDisabled": True or False, # Whether configuring Wi-Fi networks is disabled. Supported on fully managed devices and work profiles on company-owned devices. For fully managed devices, setting this to true removes all configured networks and retains only the networks configured using openNetworkConfiguration. For work profiles on company-owned devices, existing configured networks are not affected and the user is not allowed to add, remove, or modify Wi-Fi networks. If configureWifi is set to anything other than CONFIGURE_WIFI_UNSPECIFIED, this setting is ignored. Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled). - "wifiConfigsLockdownEnabled": True or False, # DEPRECATED - Use wifi_config_disabled. + "wifiConfigsLockdownEnabled": True or False, # This is deprecated. } diff --git a/docs/dyn/apigee_v1.organizations.environments.securityActions.html b/docs/dyn/apigee_v1.organizations.environments.securityActions.html index 57f0379ed98..04e34f230f5 100644 --- a/docs/dyn/apigee_v1.organizations.environments.securityActions.html +++ b/docs/dyn/apigee_v1.organizations.environments.securityActions.html @@ -113,6 +113,9 @@

Method Details

{ # A SecurityAction is rule that can be enforced at an environment level. The result is one of: - A denied API call - An explicitly allowed API call - A flagged API call (HTTP headers added before the target receives it) At least one condition is required to create a SecurityAction. "allow": { # Message that should be set in case of an Allow Action. This does not have any fields. # Allow a request through if it matches this SecurityAction. }, + "apiProxies": [ # Optional. If unset, this would apply to all proxies in the environment. If set, this action is enforced only if at least one proxy in the repeated list is deployed at the time of enforcement. If set, several restrictions are enforced on SecurityActions. There can be at most 100 enabled actions with proxies set in an env. Several other restrictions apply on conditions and are detailed later. + "A String", + ], "conditionConfig": { # The following are a list of conditions. A valid SecurityAction must contain at least one condition. Within a condition, each element is ORed. Across conditions elements are ANDed. For example if a SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: enforce the action if the incoming request has ((ip_address_ranges = "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges and bot_reasons cannot be ANDed. # Required. A valid SecurityAction must contain at least one condition. "accessTokens": [ # Optional. A list of access_tokens. Limit 1000 per action. "A String", @@ -180,6 +183,9 @@

Method Details

{ # A SecurityAction is rule that can be enforced at an environment level. The result is one of: - A denied API call - An explicitly allowed API call - A flagged API call (HTTP headers added before the target receives it) At least one condition is required to create a SecurityAction. "allow": { # Message that should be set in case of an Allow Action. This does not have any fields. # Allow a request through if it matches this SecurityAction. }, + "apiProxies": [ # Optional. If unset, this would apply to all proxies in the environment. If set, this action is enforced only if at least one proxy in the repeated list is deployed at the time of enforcement. If set, several restrictions are enforced on SecurityActions. There can be at most 100 enabled actions with proxies set in an env. Several other restrictions apply on conditions and are detailed later. + "A String", + ], "conditionConfig": { # The following are a list of conditions. A valid SecurityAction must contain at least one condition. Within a condition, each element is ORed. Across conditions elements are ANDed. For example if a SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: enforce the action if the incoming request has ((ip_address_ranges = "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges and bot_reasons cannot be ANDed. # Required. A valid SecurityAction must contain at least one condition. "accessTokens": [ # Optional. A list of access_tokens. Limit 1000 per action. "A String", @@ -259,6 +265,9 @@

Method Details

{ # A SecurityAction is rule that can be enforced at an environment level. The result is one of: - A denied API call - An explicitly allowed API call - A flagged API call (HTTP headers added before the target receives it) At least one condition is required to create a SecurityAction. "allow": { # Message that should be set in case of an Allow Action. This does not have any fields. # Allow a request through if it matches this SecurityAction. }, + "apiProxies": [ # Optional. If unset, this would apply to all proxies in the environment. If set, this action is enforced only if at least one proxy in the repeated list is deployed at the time of enforcement. If set, several restrictions are enforced on SecurityActions. There can be at most 100 enabled actions with proxies set in an env. Several other restrictions apply on conditions and are detailed later. + "A String", + ], "conditionConfig": { # The following are a list of conditions. A valid SecurityAction must contain at least one condition. Within a condition, each element is ORed. Across conditions elements are ANDed. For example if a SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: enforce the action if the incoming request has ((ip_address_ranges = "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges and bot_reasons cannot be ANDed. # Required. A valid SecurityAction must contain at least one condition. "accessTokens": [ # Optional. A list of access_tokens. Limit 1000 per action. "A String", @@ -338,6 +347,9 @@

Method Details

{ # A SecurityAction is rule that can be enforced at an environment level. The result is one of: - A denied API call - An explicitly allowed API call - A flagged API call (HTTP headers added before the target receives it) At least one condition is required to create a SecurityAction. "allow": { # Message that should be set in case of an Allow Action. This does not have any fields. # Allow a request through if it matches this SecurityAction. }, + "apiProxies": [ # Optional. If unset, this would apply to all proxies in the environment. If set, this action is enforced only if at least one proxy in the repeated list is deployed at the time of enforcement. If set, several restrictions are enforced on SecurityActions. There can be at most 100 enabled actions with proxies set in an env. Several other restrictions apply on conditions and are detailed later. + "A String", + ], "conditionConfig": { # The following are a list of conditions. A valid SecurityAction must contain at least one condition. Within a condition, each element is ORed. Across conditions elements are ANDed. For example if a SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: enforce the action if the incoming request has ((ip_address_ranges = "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges and bot_reasons cannot be ANDed. # Required. A valid SecurityAction must contain at least one condition. "accessTokens": [ # Optional. A list of access_tokens. Limit 1000 per action. "A String", @@ -411,6 +423,9 @@

Method Details

{ # A SecurityAction is rule that can be enforced at an environment level. The result is one of: - A denied API call - An explicitly allowed API call - A flagged API call (HTTP headers added before the target receives it) At least one condition is required to create a SecurityAction. "allow": { # Message that should be set in case of an Allow Action. This does not have any fields. # Allow a request through if it matches this SecurityAction. }, + "apiProxies": [ # Optional. If unset, this would apply to all proxies in the environment. If set, this action is enforced only if at least one proxy in the repeated list is deployed at the time of enforcement. If set, several restrictions are enforced on SecurityActions. There can be at most 100 enabled actions with proxies set in an env. Several other restrictions apply on conditions and are detailed later. + "A String", + ], "conditionConfig": { # The following are a list of conditions. A valid SecurityAction must contain at least one condition. Within a condition, each element is ORed. Across conditions elements are ANDed. For example if a SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: enforce the action if the incoming request has ((ip_address_ranges = "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges and bot_reasons cannot be ANDed. # Required. A valid SecurityAction must contain at least one condition. "accessTokens": [ # Optional. A list of access_tokens. Limit 1000 per action. "A String", @@ -490,6 +505,9 @@

Method Details

{ # A SecurityAction is rule that can be enforced at an environment level. The result is one of: - A denied API call - An explicitly allowed API call - A flagged API call (HTTP headers added before the target receives it) At least one condition is required to create a SecurityAction. "allow": { # Message that should be set in case of an Allow Action. This does not have any fields. # Allow a request through if it matches this SecurityAction. }, + "apiProxies": [ # Optional. If unset, this would apply to all proxies in the environment. If set, this action is enforced only if at least one proxy in the repeated list is deployed at the time of enforcement. If set, several restrictions are enforced on SecurityActions. There can be at most 100 enabled actions with proxies set in an env. Several other restrictions apply on conditions and are detailed later. + "A String", + ], "conditionConfig": { # The following are a list of conditions. A valid SecurityAction must contain at least one condition. Within a condition, each element is ORed. Across conditions elements are ANDed. For example if a SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: enforce the action if the incoming request has ((ip_address_ranges = "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges and bot_reasons cannot be ANDed. # Required. A valid SecurityAction must contain at least one condition. "accessTokens": [ # Optional. A list of access_tokens. Limit 1000 per action. "A String", diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html index 04d3a374ca0..2986b5b80a6 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html @@ -207,7 +207,7 @@

Method Details

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

Method Details

"repositoryPath": "A String", # A custom field to define a path to a specific repository from the base. }, }, + "commonRepository": { # Common remote repository settings type. # Common remote repository settings. Used as the RR upstream URL instead of Predefined and Custom remote repositories. UI and Gcloud will map all the new remote repositories to this field. + "uri": "A String", # Required. A common public repository base for Remote Repository. + }, "description": "A String", # The description of the remote source. "disableUpstreamValidation": True or False, # Input only. A create/update remote repo option to avoid making a HEAD/GET request to validate a remote repo and any supplied upstream credentials. "dockerRepository": { # Configuration for a Docker remote repository. # Specific settings for a Docker remote repository. @@ -425,6 +428,9 @@

Method Details

"repositoryPath": "A String", # A custom field to define a path to a specific repository from the base. }, }, + "commonRepository": { # Common remote repository settings type. # Common remote repository settings. Used as the RR upstream URL instead of Predefined and Custom remote repositories. UI and Gcloud will map all the new remote repositories to this field. + "uri": "A String", # Required. A common public repository base for Remote Repository. + }, "description": "A String", # The description of the remote source. "disableUpstreamValidation": True or False, # Input only. A create/update remote repo option to avoid making a HEAD/GET request to validate a remote repo and any supplied upstream credentials. "dockerRepository": { # Configuration for a Docker remote repository. # Specific settings for a Docker remote repository. @@ -524,7 +530,7 @@

Method Details

Args: parent: string, Required. The name of the parent resource whose repositories will be listed. (required) - filter: string, Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` Examples of using a filter: To filter the results of your request to repositories with the name "my-repo" in project my-project in the us-central region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-*"` * `name="projects/my-project/locations/us-central1/repositories/*repo"` * `name="projects/my-project/locations/us-central1/repositories/*repo*"` + filter: string, Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` Examples of using a filter: To filter the results of your request to repositories with the name `my-repo` in project `my-project` in the `us-central` region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-*"` * `name="projects/my-project/locations/us-central1/repositories/*repo"` * `name="projects/my-project/locations/us-central1/repositories/*repo*"` orderBy: string, Optional. The field to order the results by. pageSize: integer, The maximum number of repositories to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. @@ -594,6 +600,9 @@

Method Details

"repositoryPath": "A String", # A custom field to define a path to a specific repository from the base. }, }, + "commonRepository": { # Common remote repository settings type. # Common remote repository settings. Used as the RR upstream URL instead of Predefined and Custom remote repositories. UI and Gcloud will map all the new remote repositories to this field. + "uri": "A String", # Required. A common public repository base for Remote Repository. + }, "description": "A String", # The description of the remote source. "disableUpstreamValidation": True or False, # Input only. A create/update remote repo option to avoid making a HEAD/GET request to validate a remote repo and any supplied upstream credentials. "dockerRepository": { # Configuration for a Docker remote repository. # Specific settings for a Docker remote repository. @@ -732,6 +741,9 @@

Method Details

"repositoryPath": "A String", # A custom field to define a path to a specific repository from the base. }, }, + "commonRepository": { # Common remote repository settings type. # Common remote repository settings. Used as the RR upstream URL instead of Predefined and Custom remote repositories. UI and Gcloud will map all the new remote repositories to this field. + "uri": "A String", # Required. A common public repository base for Remote Repository. + }, "description": "A String", # The description of the remote source. "disableUpstreamValidation": True or False, # Input only. A create/update remote repo option to avoid making a HEAD/GET request to validate a remote repo and any supplied upstream credentials. "dockerRepository": { # Configuration for a Docker remote repository. # Specific settings for a Docker remote repository. @@ -853,6 +865,9 @@

Method Details

"repositoryPath": "A String", # A custom field to define a path to a specific repository from the base. }, }, + "commonRepository": { # Common remote repository settings type. # Common remote repository settings. Used as the RR upstream URL instead of Predefined and Custom remote repositories. UI and Gcloud will map all the new remote repositories to this field. + "uri": "A String", # Required. A common public repository base for Remote Repository. + }, "description": "A String", # The description of the remote source. "disableUpstreamValidation": True or False, # Input only. A create/update remote repo option to avoid making a HEAD/GET request to validate a remote repo and any supplied upstream credentials. "dockerRepository": { # Configuration for a Docker remote repository. # Specific settings for a Docker remote repository. diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.html index 9e7627e569f..7bfb38f3308 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.html @@ -174,7 +174,7 @@

Method Details

Args: parent: string, Required. The name of the parent resource whose packages will be listed. (required) - filter: string, Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to packages with the name "my-package" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*package"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*"` To filter the results of your request to packages with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request": * "annotations.external_link:external_link_value" To filter the results just for a specific annotation key `external_link`, append the following filter expression to your request: * "annotations.external_link" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [`external.link`:`https://example.com/my-package`], append the following filter expression to your request: * "annotations.`external.link`:`https://example.com/my-package`" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * "annotations.*_link:`*example.com*`" + filter: string, Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to packages with the name `my-package` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*package"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*"` To filter the results of your request to packages with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request": * `"annotations.external_link:external_link_value"` To filter the results just for a specific annotation key `external_link`, append the following filter expression to your request: * `"annotations.external_link"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [`external.link`:`https://example.com/my-package`], append the following filter expression to your request: * `` "annotations.`external.link`:`https://example.com/my-package`" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` "annotations.*_link:`*example.com*`" `` orderBy: string, Optional. The field to order the results by. pageSize: integer, The maximum number of packages to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html index 210a0f22d13..bfe66f9495b 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: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name "my-tag" in package "my-package" in repository "my-repo" in project "my-project" in the us-central region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` + filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name `my-tag` in package `my-package` in repository `my-repo` in project "`y-project` in the us-central region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. x__xgafv: string, V1 error format. diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.versions.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.versions.html index 6a742d928ec..f22e3d17012 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.versions.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.versions.html @@ -221,7 +221,7 @@

Method Details

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

Method Details

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

Method Details

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

Method Details

}, ], "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. + "labels": { # Labels to apply to instances that are created from these properties. + "a_key": "A String", + }, "machineType": "A String", # The machine type to use for instances that are created from these properties. "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information. "items": [ # Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB. @@ -440,6 +443,9 @@

Method Details

}, ], "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. + "labels": { # Labels to apply to instances that are created from these properties. + "a_key": "A String", + }, "machineType": "A String", # The machine type to use for instances that are created from these properties. "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information. "items": [ # Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB. @@ -667,6 +673,9 @@

Method Details

}, ], "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. + "labels": { # Labels to apply to instances that are created from these properties. + "a_key": "A String", + }, "machineType": "A String", # The machine type to use for instances that are created from these properties. "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information. "items": [ # Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB. diff --git a/docs/dyn/baremetalsolution_v2.projects.locations.provisioningConfigs.html b/docs/dyn/baremetalsolution_v2.projects.locations.provisioningConfigs.html index 99f77ec8523..eb177b0942d 100644 --- a/docs/dyn/baremetalsolution_v2.projects.locations.provisioningConfigs.html +++ b/docs/dyn/baremetalsolution_v2.projects.locations.provisioningConfigs.html @@ -164,13 +164,14 @@

Method Details

"serviceCidr": "A String", # Service CIDR, if any. "type": "A String", # The type of this network, either Client or Private. "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . - "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). + "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf { # A GCP vlan attachment. "id": "A String", # Identifier of the VLAN attachment. "pairingKey": "A String", # Attachment pairing key. }, ], "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. + "vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. }, ], "pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. @@ -283,13 +284,14 @@

Method Details

"serviceCidr": "A String", # Service CIDR, if any. "type": "A String", # The type of this network, either Client or Private. "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . - "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). + "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf { # A GCP vlan attachment. "id": "A String", # Identifier of the VLAN attachment. "pairingKey": "A String", # Attachment pairing key. }, ], "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. + "vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. }, ], "pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. @@ -408,13 +410,14 @@

Method Details

"serviceCidr": "A String", # Service CIDR, if any. "type": "A String", # The type of this network, either Client or Private. "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . - "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). + "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf { # A GCP vlan attachment. "id": "A String", # Identifier of the VLAN attachment. "pairingKey": "A String", # Attachment pairing key. }, ], "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. + "vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. }, ], "pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. @@ -528,13 +531,14 @@

Method Details

"serviceCidr": "A String", # Service CIDR, if any. "type": "A String", # The type of this network, either Client or Private. "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . - "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). + "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf { # A GCP vlan attachment. "id": "A String", # Identifier of the VLAN attachment. "pairingKey": "A String", # Attachment pairing key. }, ], "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. + "vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. }, ], "pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. @@ -648,13 +652,14 @@

Method Details

"serviceCidr": "A String", # Service CIDR, if any. "type": "A String", # The type of this network, either Client or Private. "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . - "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). + "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf { # A GCP vlan attachment. "id": "A String", # Identifier of the VLAN attachment. "pairingKey": "A String", # Attachment pairing key. }, ], "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. + "vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. }, ], "pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. @@ -770,13 +775,14 @@

Method Details

"serviceCidr": "A String", # Service CIDR, if any. "type": "A String", # The type of this network, either Client or Private. "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . - "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). + "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf { # A GCP vlan attachment. "id": "A String", # Identifier of the VLAN attachment. "pairingKey": "A String", # Attachment pairing key. }, ], "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. + "vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. }, ], "pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. @@ -890,13 +896,14 @@

Method Details

"serviceCidr": "A String", # Service CIDR, if any. "type": "A String", # The type of this network, either Client or Private. "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . - "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). + "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf { # A GCP vlan attachment. "id": "A String", # Identifier of the VLAN attachment. "pairingKey": "A String", # Attachment pairing key. }, ], "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. + "vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. }, ], "pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 095265ef824..dbe542077db 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -1126,6 +1126,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -2905,6 +2910,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -4702,6 +4712,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -6487,6 +6502,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -8277,6 +8297,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -10050,6 +10075,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -11823,6 +11853,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -13596,6 +13631,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 74255edea94..2881d6ccfee 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -1241,6 +1241,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -3009,6 +3014,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -4777,6 +4787,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -6543,6 +6558,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -8307,6 +8327,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -10071,6 +10096,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -12134,6 +12164,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -13902,6 +13937,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -15670,6 +15710,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -17436,6 +17481,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -19200,6 +19250,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. @@ -20964,6 +21019,11 @@

Method Details

{ # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ``` "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link. + "chatSpaceLinkData": { # Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview). # Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview). + "message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}` + "space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}` + "thread": "A String", # The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}` + }, "driveLinkData": { # Data for Google Drive links. # Data for a drive link. "driveDataRef": { # A reference to the data of a drive attachment. # A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file. "driveFileId": "A String", # The ID for the drive file. Use with the Drive API. diff --git a/docs/dyn/checks_v1alpha.accounts.html b/docs/dyn/checks_v1alpha.accounts.html index bf20a3b1194..aafe151303a 100644 --- a/docs/dyn/checks_v1alpha.accounts.html +++ b/docs/dyn/checks_v1alpha.accounts.html @@ -79,6 +79,11 @@

Instance Methods

Returns the apps Resource.

+

+ repos() +

+

Returns the repos Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/checks_v1alpha.accounts.repos.html b/docs/dyn/checks_v1alpha.accounts.repos.html new file mode 100644 index 00000000000..aa32788975e --- /dev/null +++ b/docs/dyn/checks_v1alpha.accounts.repos.html @@ -0,0 +1,91 @@ + + + +

Checks API . accounts . repos

+

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/checks_v1alpha.accounts.repos.operations.html b/docs/dyn/checks_v1alpha.accounts.repos.operations.html new file mode 100644 index 00000000000..054f3bf05bf --- /dev/null +++ b/docs/dyn/checks_v1alpha.accounts.repos.operations.html @@ -0,0 +1,124 @@ + + + +

Checks API . accounts . repos . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudasset_v1.operations.html b/docs/dyn/cloudasset_v1.operations.html index 2526611839c..d3139edec8d 100644 --- a/docs/dyn/cloudasset_v1.operations.html +++ b/docs/dyn/cloudasset_v1.operations.html @@ -74,66 +74,18 @@

Cloud Asset API . operations

Instance Methods

-

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

-

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

close()

Close httplib2 connections.

-

- delete(name, x__xgafv=None)

-

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Method Details

-
- cancel(name, body=None, x__xgafv=None) -
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
-
-Args:
-  name: string, The name of the operation resource to be cancelled. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The request message for Operations.CancelOperation.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
-}
-
-
close()
Close httplib2 connections.
-
- delete(name, x__xgafv=None) -
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
-
-Args:
-  name: string, The name of the operation 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:
-
-    { # 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 the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
diff --git a/docs/dyn/cloudasset_v1.v1.html b/docs/dyn/cloudasset_v1.v1.html
index d7bb748ee6b..aa101058ee3 100644
--- a/docs/dyn/cloudasset_v1.v1.html
+++ b/docs/dyn/cloudasset_v1.v1.html
@@ -2329,7 +2329,7 @@ 

Method Details

], }, ], - "enrichments": [ # Enrichments of the asset. Currently supported enrichment types with SearchAllResources API: * RESOURCE_OWNERS The corresponding read masks in order to get the enrichment: * enrichments.resource_owners The corresponding required permissions: * cloudasset.assets.searchEnrichmentResourceOwners Example query to get resource owner enrichment: scope: "projects/my-project" query: "name: my-project" assetTypes: "cloudresourcemanager.googleapis.com/Project" readMask: { paths: "asset_type" paths: "name" paths: "enrichments.resource_owners" } + "enrichments": [ # Enrichments of the asset. Currently supported enrichment types with SearchAllResources API: * RESOURCE_OWNERS The corresponding read masks in order to get the enrichment: * enrichments.resource_owners The corresponding required permissions: * cloudasset.assets.searchEnrichmentResourceOwners Example query to get resource owner enrichment: ``` scope: "projects/my-project" query: "name: my-project" assetTypes: "cloudresourcemanager.googleapis.com/Project" readMask: { paths: "asset_type" paths: "name" paths: "enrichments.resource_owners" } ``` { # The enhanced metadata information for a resource. "resourceOwners": { # The resource owners information. # The resource owners for a resource. Note that this field only contains the members that have "roles/owner" role in the resource's IAM Policy. "resourceOwners": [ # List of resource owners. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html index 9214132e968..e4fdf48c8e9 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html @@ -613,7 +613,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. @@ -1152,7 +1152,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. @@ -1719,7 +1719,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. @@ -2270,7 +2270,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. @@ -2826,7 +2826,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. @@ -3367,7 +3367,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index 662205fc333..eacf55995d6 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -613,7 +613,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. @@ -1152,7 +1152,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. @@ -1719,7 +1719,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. @@ -2270,7 +2270,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. @@ -2827,7 +2827,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. @@ -3366,7 +3366,7 @@

Method Details

"repositoryType": "A String", # Output only. The type of the SCM vendor the repository points to. }, "resourceName": "A String", # The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. - "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` + "serviceAccount": "A String", # The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` "sourceToBuild": { # GitRepoSource describes a repo and ref of a code repository. # The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. "bitbucketServerConfig": "A String", # The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. "githubEnterpriseConfig": "A String", # The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`. diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html index 1b551f6ea8e..75ab86db545 100644 --- a/docs/dyn/compute_alpha.html +++ b/docs/dyn/compute_alpha.html @@ -494,6 +494,11 @@

Instance Methods

Returns the regions Resource.

+

+ reservationBlocks() +

+

Returns the reservationBlocks Resource.

+

reservations()

diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html index 93ee59d3c5d..c803704b3ce 100644 --- a/docs/dyn/compute_alpha.regionCommitments.html +++ b/docs/dyn/compute_alpha.regionCommitments.html @@ -189,8 +189,10 @@

Method Details

"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 }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "description": "A String", # 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. + "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -200,6 +202,7 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). "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. @@ -664,8 +667,10 @@

Method Details

"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 }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "description": "A String", # 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. + "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -675,6 +680,7 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). "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. @@ -832,8 +838,10 @@

Method Details

"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 }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "description": "A String", # 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. + "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -843,6 +851,7 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). "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. @@ -1130,8 +1139,10 @@

Method Details

"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 }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "description": "A String", # 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. + "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -1141,6 +1152,7 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). "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. @@ -1360,8 +1372,10 @@

Method Details

"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 }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "description": "A String", # 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. + "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -1371,6 +1385,7 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). "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. @@ -1626,8 +1641,10 @@

Method Details

"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 }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "description": "A String", # 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. + "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -1637,6 +1654,7 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). "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. diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html index 2d49f57b146..46b9a46f74c 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html @@ -74,9 +74,15 @@

Compute Engine API . regionInstanceGroupManagerResizeRequests

Instance Methods

+

+ cancel(project, region, instanceGroupManager, resizeRequest, requestId=None, x__xgafv=None)

+

Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.

close()

Close httplib2 connections.

+

+ delete(project, region, instanceGroupManager, resizeRequest, requestId=None, x__xgafv=None)

+

Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.

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

Returns all of the details about the specified resize request.

@@ -90,11 +96,265 @@

Instance Methods

list_next()

Retrieves the next page of results.

Method Details

+
+ cancel(project, region, instanceGroupManager, resizeRequest, requestId=None, x__xgafv=None) +
Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.
+
+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 to cancel. Name should conform to RFC1035 or be a resource ID. (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.
+}
+
+
close()
Close httplib2 connections.
+
+ delete(project, region, instanceGroupManager, resizeRequest, requestId=None, x__xgafv=None) +
Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.
+
+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 to delete. Name should conform to RFC1035 or be a resource ID. (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, instanceGroupManager, resizeRequest, x__xgafv=None)
Returns all of the details about the specified resize request.
diff --git a/docs/dyn/compute_alpha.reservationBlocks.html b/docs/dyn/compute_alpha.reservationBlocks.html
new file mode 100644
index 00000000000..114ed06caef
--- /dev/null
+++ b/docs/dyn/compute_alpha.reservationBlocks.html
@@ -0,0 +1,197 @@
+
+
+
+

Compute Engine API . reservationBlocks

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, zone, reservation, reservationBlock, x__xgafv=None)

+

Retrieves information about the specified reservation block.

+

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

+

Retrieves a list of reservation blocks under a single reservation.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, zone, reservation, reservationBlock, x__xgafv=None) +
Retrieves information about the specified reservation block.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+  reservation: string, The name of the reservation. Name should conform to RFC1035 or be a resource ID. (required)
+  reservationBlock: string, The name of the reservation block. 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:
+
+    {
+  "resource": { # Represents a reservation block resource.
+    "count": 42, # [Output Only] Specifies the number of resources that are allocated in this block. It indicates the maximum number of VMs that a user can run on this particular block.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "inUseCount": 42, # [Output Only] Indicates how many instances are in use on this block.
+    "kind": "A String", # [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks.
+    "locationPrefix": "A String", # [Output Only] Obfuscated location where this reservation block physically resides in format /CCCC/GGGG. This matches the tripod specified in the VM topology information. Example: /USEAB1/0101/ is the location prefix in /USEAB1/0101/031/003
+    "name": "A String", # [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
+    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+    "status": "A String", # [Output Only] Status of the reservation block.
+    "zone": "A String", # [Output Only] Zone in which the reservation block resides.
+  },
+}
+
+ +
+ list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves a list of reservation blocks under a single reservation.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+  reservation: string, The name of the reservation. Name should conform to RFC1035 or be a resource ID. (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:
+
+    { # A list of reservation blocks under a single reservation.
+  "id": "A String", # Unique identifier for the resource; defined by the server.
+  "items": [ # A list of reservation block resources.
+    { # Represents a reservation block resource.
+      "count": 42, # [Output Only] Specifies the number of resources that are allocated in this block. It indicates the maximum number of VMs that a user can run on this particular block.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "inUseCount": 42, # [Output Only] Indicates how many instances are in use on this block.
+      "kind": "A String", # [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks.
+      "locationPrefix": "A String", # [Output Only] Obfuscated location where this reservation block physically resides in format /CCCC/GGGG. This matches the tripod specified in the VM topology information. Example: /USEAB1/0101/ is the location prefix in /USEAB1/0101/031/003
+      "name": "A String", # [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
+      "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+      "status": "A String", # [Output Only] Status of the reservation block.
+      "zone": "A String", # [Output Only] Zone in which the reservation block resides.
+    },
+  ],
+  "kind": "compute#reservationBlock", # Type of the resource. Always compute#reservationBlock for a list of reservation blocks.
+  "nextPageToken": "A String", # 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", # Server-defined URL for this resource.
+  "warning": { # 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.reservations.html b/docs/dyn/compute_alpha.reservations.html index 35e904ff4cc..1132c50b799 100644 --- a/docs/dyn/compute_alpha.reservations.html +++ b/docs/dyn/compute_alpha.reservations.html @@ -168,8 +168,10 @@

Method Details

"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 }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "description": "A String", # 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. + "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -179,6 +181,7 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). "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. @@ -455,8 +458,10 @@

Method Details

"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 }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "description": "A String", # 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. + "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -466,6 +471,7 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). "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. @@ -662,8 +668,10 @@

Method Details

"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 }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "description": "A String", # 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. + "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -673,6 +681,7 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). "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. @@ -898,8 +907,10 @@

Method Details

"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 }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "description": "A String", # 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. + "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -909,6 +920,7 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). "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. @@ -1403,8 +1415,10 @@

Method Details

"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 }, "deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. + "deploymentType": "A String", # Specifies the deployment strategy for this reservation. "description": "A String", # 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. + "instanceTerminationAction": "A String", # Instance termination action that will be invoked when the reservation is deleted. "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations. "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. @@ -1414,6 +1428,7 @@

Method Details

"a_key": "A String", }, "resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. + "reservationBlockCount": 42, # Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). "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. diff --git a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html index 31d8a0a16c4..01a2b5e1816 100644 --- a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html @@ -121,6 +121,7 @@

Method Details

"annotations": { # Metadata defined as annotations on the network endpoint. "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. "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. @@ -391,6 +392,7 @@

Method Details

"annotations": { # Metadata defined as annotations on the network endpoint. "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. "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. @@ -858,6 +860,7 @@

Method Details

"annotations": { # Metadata defined as annotations on the network endpoint. "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. "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_v1.networkEndpointGroups.html b/docs/dyn/compute_v1.networkEndpointGroups.html index a2bb50c135f..42a470fcafc 100644 --- a/docs/dyn/compute_v1.networkEndpointGroups.html +++ b/docs/dyn/compute_v1.networkEndpointGroups.html @@ -241,6 +241,7 @@

Method Details

"annotations": { # Metadata defined as annotations on the network endpoint. "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. "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. @@ -513,6 +514,7 @@

Method Details

"annotations": { # Metadata defined as annotations on the network endpoint. "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. "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. @@ -991,6 +993,7 @@

Method Details

"annotations": { # Metadata defined as annotations on the network endpoint. "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. "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_v1.regionNetworkEndpointGroups.html b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html index a56f443d8b0..e9ea4f4b7af 100644 --- a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html @@ -122,6 +122,7 @@

Method Details

"annotations": { # Metadata defined as annotations on the network endpoint. "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. "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

"annotations": { # Metadata defined as annotations on the network endpoint. "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. "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. @@ -865,6 +867,7 @@

Method Details

"annotations": { # Metadata defined as annotations on the network endpoint. "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. "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/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index df05cac4705..dc0bbb27cea 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -188,6 +188,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -221,6 +228,7 @@

Method Details

"username": "A String", # Username. }, }, + "authOverrideEnabled": True or False, # Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API. "billingConfig": { # Billing config for the connection. # Output only. Billing config for the connection. "billingCategory": "A String", # Output only. Billing category for the connector. }, @@ -261,6 +269,7 @@

Method Details

"memory": "A String", # Output only. Memory request. }, "sharedDeployment": "A String", # Output only. The name of shared connector deployment. + "tlsMigrationState": "A String", # Output only. Status of the TLS migration. }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. @@ -326,6 +335,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -397,6 +413,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -667,6 +690,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -700,6 +730,7 @@

Method Details

"username": "A String", # Username. }, }, + "authOverrideEnabled": True or False, # Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API. "billingConfig": { # Billing config for the connection. # Output only. Billing config for the connection. "billingCategory": "A String", # Output only. Billing category for the connector. }, @@ -740,6 +771,7 @@

Method Details

"memory": "A String", # Output only. Memory request. }, "sharedDeployment": "A String", # Output only. The name of shared connector deployment. + "tlsMigrationState": "A String", # Output only. Status of the TLS migration. }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. @@ -805,6 +837,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -876,6 +915,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -1165,6 +1211,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -1198,6 +1251,7 @@

Method Details

"username": "A String", # Username. }, }, + "authOverrideEnabled": True or False, # Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API. "billingConfig": { # Billing config for the connection. # Output only. Billing config for the connection. "billingCategory": "A String", # Output only. Billing category for the connector. }, @@ -1238,6 +1292,7 @@

Method Details

"memory": "A String", # Output only. Memory request. }, "sharedDeployment": "A String", # Output only. The name of shared connector deployment. + "tlsMigrationState": "A String", # Output only. Status of the TLS migration. }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. @@ -1303,6 +1358,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -1374,6 +1436,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -1617,6 +1686,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -1650,6 +1726,7 @@

Method Details

"username": "A String", # Username. }, }, + "authOverrideEnabled": True or False, # Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API. "billingConfig": { # Billing config for the connection. # Output only. Billing config for the connection. "billingCategory": "A String", # Output only. Billing category for the connector. }, @@ -1690,6 +1767,7 @@

Method Details

"memory": "A String", # Output only. Memory request. }, "sharedDeployment": "A String", # Output only. The name of shared connector deployment. + "tlsMigrationState": "A String", # Output only. Status of the TLS migration. }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. @@ -1755,6 +1833,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -1826,6 +1911,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -2202,6 +2294,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -2235,6 +2334,7 @@

Method Details

"username": "A String", # Username. }, }, + "authOverrideEnabled": True or False, # Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API. "billingConfig": { # Billing config for the connection. # Output only. Billing config for the connection. "billingCategory": "A String", # Output only. Billing category for the connector. }, @@ -2275,6 +2375,7 @@

Method Details

"memory": "A String", # Output only. Memory request. }, "sharedDeployment": "A String", # Output only. The name of shared connector deployment. + "tlsMigrationState": "A String", # Output only. Status of the TLS migration. }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. @@ -2340,6 +2441,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -2411,6 +2519,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. 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..27a5fd6a8aa 100644 --- a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html +++ b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html @@ -137,6 +137,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -341,6 +348,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -520,6 +534,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. 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 94a8ee6cdc0..6a2e03a1400 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -82,6 +82,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ fetchAuthSchema(name, view=None, x__xgafv=None)

+

fetch and return the list of auth config variables required to override the connection backend auth.

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

Gets details of a single connector version.

@@ -97,6 +100,64 @@

Method Details

Close httplib2 connections.
+
+ fetchAuthSchema(name, view=None, x__xgafv=None) +
fetch and return the list of auth config variables required to override the connection backend auth.
+
+Args:
+  name: string, Required. Parent resource of the Connector Version, of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*` (required)
+  view: string, Optional. View of the AuthSchema. The default value is BASIC.
+    Allowed values
+      AUTH_SCHEMA_VIEW_UNSPECIFIED - Default value.
+      BASIC - Basic view of the AuthSchema.
+      JSON_SCHEMA - JSON schema view of the AuthSchema.
+  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 Connectors.GetAuthSchema.
+  "authSchemas": [ # List of AuthSchemas.
+    { # AuthSchema defines the schema of an authentication type.
+      "authFields": [ # List of AuthFields.
+        { # AuthField defines a field in an authentication type.
+          "dataType": "A String", # Data type of the field.
+          "description": "A String", # Description of the field.
+          "key": "A String", # Key of the field.
+        },
+      ],
+      "authKey": "A String", # Auth key of the schema.
+      "authType": "A String", # Auth type of the schema.
+      "description": "A String", # Description of the schema.
+      "displayName": "A String", # Display name of the schema.
+      "isDefault": True or False, # Whether the auth schema is the default one.
+    },
+  ],
+  "jsonSchema": { # JsonAuthSchema defines the JSON schema of all authentication types. # JSON schema of the AuthSchemas. This is only populated if the view is JSON_SCHEMA. The schema is in draft-07 format.
+    "$schema": "A String", # JSON schema of the AuthSchemas.
+    "oneOf": [ # List of AuthObjects.
+      { # AuthObject defines a JSON schema of an authentication type.
+        "additionalProperties": True or False, # Whether the object has additional properties.
+        "authKey": "A String", # Auth key of the object.
+        "authType": "A String", # Auth type of the object.
+        "description": "A String", # Description of the object.
+        "isDefault": True or False, # Whether the object is the default one.
+        "properties": { # Properties of the object.
+          "a_key": { # AuthProperty defines a property of an authentication type.
+            "description": "A String", # Description of the property.
+            "type": "A String", # Type of the property.
+          },
+        },
+        "type": "A String", # Type of the object.
+      },
+    ],
+  },
+}
+
+
get(name, view=None, x__xgafv=None)
Gets details of a single connector version.
@@ -271,6 +332,7 @@ 

Method Details

"internalclientRatelimitThreshold": "A String", # Max QPS supported for internal requests originating from Connd. "maxInstanceRequestConcurrency": 42, # Max Instance Request Conncurrency for Cloud Run service. "migrateDeploymentModel": True or False, # Indicate whether connector is being migrated to cloud run deployment model. + "migrateTls": True or False, # Indicate whether connector is being migrated to TLS. "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. @@ -1014,6 +1076,7 @@

Method Details

"internalclientRatelimitThreshold": "A String", # Max QPS supported for internal requests originating from Connd. "maxInstanceRequestConcurrency": 42, # Max Instance Request Conncurrency for Cloud Run service. "migrateDeploymentModel": True or False, # Indicate whether connector is being migrated to cloud run deployment model. + "migrateTls": True or False, # Indicate whether connector is being migrated to TLS. "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/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html index 650aaa2ab08..92eab095120 100644 --- a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html +++ b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html @@ -117,7 +117,7 @@

Method Details

}, "ccaipManagedUsers": True or False, # Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity "createTime": "A String", # Output only. [Output only] Create time stamp - "critical": { # Instances in this Channel will receive updates after all instances in `Critical` were updated + 2 days. They also will only be updated outside of their peak hours. # Optional. Critical release channel. + "critical": { # Instances in this Channel will receive updates after all instances in `Normal` were updated. They also will only be updated outside of their peak hours. # Optional. Critical release channel. "peakHours": [ # Required. Hours during which the instance should not be updated. { # Message representing a weekly schedule. "days": [ # Required. Days of the week this schedule applies to. @@ -174,6 +174,9 @@

Method Details

"allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components. "A String", ], + "producerProjectIds": [ # Output only. The CCAIP tenant project ids. + "A String", + ], }, }, "privateComponents": [ # Output only. TODO(b/283407860) Deprecate this field. @@ -288,7 +291,7 @@

Method Details

}, "ccaipManagedUsers": True or False, # Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity "createTime": "A String", # Output only. [Output only] Create time stamp - "critical": { # Instances in this Channel will receive updates after all instances in `Critical` were updated + 2 days. They also will only be updated outside of their peak hours. # Optional. Critical release channel. + "critical": { # Instances in this Channel will receive updates after all instances in `Normal` were updated. They also will only be updated outside of their peak hours. # Optional. Critical release channel. "peakHours": [ # Required. Hours during which the instance should not be updated. { # Message representing a weekly schedule. "days": [ # Required. Days of the week this schedule applies to. @@ -345,6 +348,9 @@

Method Details

"allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components. "A String", ], + "producerProjectIds": [ # Output only. The CCAIP tenant project ids. + "A String", + ], }, }, "privateComponents": [ # Output only. TODO(b/283407860) Deprecate this field. @@ -399,7 +405,7 @@

Method Details

}, "ccaipManagedUsers": True or False, # Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity "createTime": "A String", # Output only. [Output only] Create time stamp - "critical": { # Instances in this Channel will receive updates after all instances in `Critical` were updated + 2 days. They also will only be updated outside of their peak hours. # Optional. Critical release channel. + "critical": { # Instances in this Channel will receive updates after all instances in `Normal` were updated. They also will only be updated outside of their peak hours. # Optional. Critical release channel. "peakHours": [ # Required. Hours during which the instance should not be updated. { # Message representing a weekly schedule. "days": [ # Required. Days of the week this schedule applies to. @@ -456,6 +462,9 @@

Method Details

"allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components. "A String", ], + "producerProjectIds": [ # Output only. The CCAIP tenant project ids. + "A String", + ], }, }, "privateComponents": [ # Output only. TODO(b/283407860) Deprecate this field. @@ -519,7 +528,7 @@

Method Details

}, "ccaipManagedUsers": True or False, # Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity "createTime": "A String", # Output only. [Output only] Create time stamp - "critical": { # Instances in this Channel will receive updates after all instances in `Critical` were updated + 2 days. They also will only be updated outside of their peak hours. # Optional. Critical release channel. + "critical": { # Instances in this Channel will receive updates after all instances in `Normal` were updated. They also will only be updated outside of their peak hours. # Optional. Critical release channel. "peakHours": [ # Required. Hours during which the instance should not be updated. { # Message representing a weekly schedule. "days": [ # Required. Days of the week this schedule applies to. @@ -576,6 +585,9 @@

Method Details

"allowedConsumerProjectIds": [ # The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components. "A String", ], + "producerProjectIds": [ # Output only. The CCAIP tenant project ids. + "A String", + ], }, }, "privateComponents": [ # Output only. TODO(b/283407860) Deprecate this field. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 75d02eae48a..bf3af45528a 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -4443,6 +4443,14 @@

Method Details

"desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster. "type": "A String", # Type of the integration. }, + "desiredCompliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster. + "complianceStandards": [ # List of enabled compliance standards. + { # Defines the details of a compliance standard. + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "desiredContainerdConfig": { # ContainerdConfig contains configuration to customize containerd. # The desired containerd config for the cluster. "privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index f65989b0a43..ad97224db73 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -4470,6 +4470,14 @@

Method Details

"desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster. "type": "A String", # Type of the integration. }, + "desiredCompliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster. + "complianceStandards": [ # List of enabled compliance standards. + { # Defines the details of a compliance standard. + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "desiredContainerdConfig": { # ContainerdConfig contains configuration to customize containerd. # The desired containerd config for the cluster. "privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries. "certificateAuthorityDomainConfig": [ # Private registry access configuration. diff --git a/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html b/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html index 1d81efd53b1..4beb1d6199b 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html @@ -94,6 +94,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets the specified note.

+

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

+

Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

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

Lists notes for the specified project.

@@ -103,6 +106,12 @@

Instance Methods

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

Updates the specified note.

+

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

+

Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

+

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

+

Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Method Details

batchCreate(parent, body=None, x__xgafv=None) @@ -1707,6 +1716,49 @@

Method Details

}
+
+ getIamPolicy(resource, body=None, x__xgafv=None) +
Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+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)
+  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).
+}
+
+
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists notes for the specified project.
@@ -2675,4 +2727,92 @@ 

Method Details

}
+
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+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.
+    "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 the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+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/containeranalysis_v1beta1.projects.locations.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html index 7a97b816ff1..07d9d231265 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html @@ -89,6 +89,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets the specified occurrence.

+

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

+

Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

getNotes(name, x__xgafv=None)

Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.

@@ -104,6 +107,12 @@

Instance Methods

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

Updates the specified occurrence.

+

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

+

Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

+

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

+

Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Method Details

batchCreate(parent, body=None, x__xgafv=None) @@ -3057,6 +3066,49 @@

Method Details

}
+
+ getIamPolicy(resource, body=None, x__xgafv=None) +
Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+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)
+  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).
+}
+
+
getNotes(name, x__xgafv=None)
Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.
@@ -5188,4 +5240,92 @@ 

Method Details

}
+
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+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.
+    "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 the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html index a9824b3c31a..569f78ac4a5 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html @@ -495,7 +495,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -1027,7 +1027,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -1628,7 +1628,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -2255,7 +2255,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -2805,7 +2805,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -3338,7 +3338,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.versions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.versions.html index e344036ebd0..d732cbdb51a 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.versions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.versions.html @@ -151,7 +151,7 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -225,7 +225,7 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -258,7 +258,7 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -339,7 +339,7 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -361,7 +361,7 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html index 8276055002b..ceb952473c5 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html @@ -1070,7 +1070,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -2599,7 +2599,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html index ab594fddb58..3a4b2c5222b 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html @@ -595,7 +595,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -1240,7 +1240,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -3370,7 +3370,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -6525,7 +6525,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -7170,7 +7170,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -9300,7 +9300,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, 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 7beaef84a09..450f5b30bfc 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html @@ -692,7 +692,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -2880,7 +2880,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -6304,7 +6304,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html index 4577ff41a96..6fd78661910 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html @@ -519,7 +519,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -1087,7 +1087,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -1724,7 +1724,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -2387,7 +2387,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -2973,7 +2973,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -3542,7 +3542,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.versions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.versions.html index 0fb974d0cdc..0fa63b820ff 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.versions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.versions.html @@ -151,7 +151,7 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -225,7 +225,7 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -258,7 +258,7 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -339,7 +339,7 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -361,7 +361,7 @@

Method Details

"displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html index 83e2330a213..4b60ee595df 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html @@ -695,7 +695,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -2883,7 +2883,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -6307,7 +6307,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html index 6689ab8de38..625ad1f6428 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html @@ -1130,7 +1130,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, @@ -2767,7 +2767,7 @@

Method Details

}, "name": "A String", # The unique identifier of the flow. Format: `projects//locations//agents//flows/`. "nluSettings": { # Settings related to NLU. # NLU related settings of the flow. - "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + "classificationThreshold": 3.14, # To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. "modelTrainingMode": "A String", # Indicates NLU model training mode. "modelType": "A String", # Indicates the type of NLU model. }, diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html index 86c151c4d08..69499ebe772 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html @@ -126,6 +126,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -155,6 +169,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -208,6 +236,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -316,6 +358,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -395,6 +451,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -442,6 +512,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -472,6 +556,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html index 5a2e4bc993d..1a7eff00b93 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html @@ -380,6 +380,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. 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 4ad05625a5e..87b6625f873 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -462,6 +462,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -685,6 +699,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html index aaf24384724..440a597d9c1 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html @@ -380,6 +380,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. 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 8facf1ace7f..fc1f9e03b48 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -462,6 +462,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -685,6 +699,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html index 5c907a467b0..27646ef51c9 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html @@ -126,6 +126,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -155,6 +169,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -208,6 +236,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -316,6 +358,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -395,6 +451,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -442,6 +512,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -472,6 +556,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html index c9a9faeb3e0..a87f056ecc0 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html @@ -380,6 +380,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index e01e2425891..b464696afb4 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -462,6 +462,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -685,6 +699,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html index 429786ba56d..10e11d58c81 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html @@ -147,6 +147,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -189,6 +203,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -255,6 +283,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -406,6 +448,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -498,6 +554,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -558,6 +628,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -601,6 +685,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html index b38f6c21329..20572f3d272 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html @@ -434,6 +434,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. 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 0063e331df5..983c0ae5ffd 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -923,6 +923,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1249,6 +1263,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1328,6 +1356,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html index ebfd47be993..e7ac1d6f2d4 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html @@ -434,6 +434,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. 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 89ce7a4fe79..c99900a73ab 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -923,6 +923,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1249,6 +1263,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1328,6 +1356,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html index ac637335625..f51c6fde44a 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html @@ -147,6 +147,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -189,6 +203,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -255,6 +283,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -406,6 +448,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -498,6 +554,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -558,6 +628,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -601,6 +685,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html index 35ad98b88c5..d4ca17a2f97 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html @@ -434,6 +434,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index c17b7963034..04cf7e6a1d8 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -923,6 +923,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1249,6 +1263,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1328,6 +1356,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html index fb57272adb1..6e8a504b366 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html @@ -126,6 +126,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -155,6 +169,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -208,6 +236,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -316,6 +358,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -395,6 +451,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -442,6 +512,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -472,6 +556,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html index 15028a3798d..4fffd88a309 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html @@ -421,6 +421,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. 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 c8d3120dad1..87ba37f47f6 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -875,6 +875,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1185,6 +1199,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1251,6 +1279,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html index 917d6738554..0195db939e9 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html @@ -421,6 +421,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. 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 48a61572e12..16454bd3976 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -875,6 +875,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1185,6 +1199,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1251,6 +1279,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html index 21abd556da5..da6fa545cb1 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html @@ -126,6 +126,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -155,6 +169,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -208,6 +236,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -316,6 +358,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -395,6 +451,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -442,6 +512,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -472,6 +556,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html index 9e99ad310fd..987287ec389 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html @@ -421,6 +421,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index ba2ea5534ed..e3d0ac9e609 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -875,6 +875,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1185,6 +1199,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -1251,6 +1279,20 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + }, "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html index 790cb4182ac..db1486ec2c6 100644 --- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html @@ -138,6 +138,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -374,6 +378,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -634,6 +642,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -881,6 +893,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -1136,6 +1152,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -1373,6 +1393,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index efe31e6e2ac..6bfe436edfe 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -155,6 +155,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -208,6 +212,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -764,6 +772,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -817,6 +829,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index 56f95bcabd3..386eea30501 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -155,6 +155,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -208,6 +212,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -708,6 +716,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -761,6 +773,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html index d109c64d1b0..77ebae9904f 100644 --- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html @@ -138,6 +138,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -374,6 +378,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -634,6 +642,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -881,6 +893,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -1136,6 +1152,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -1373,6 +1393,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index fbe2c56a208..c876a05b82f 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -155,6 +155,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -208,6 +212,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -764,6 +772,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -817,6 +829,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index 5e75aed1d61..2ea9cc15aa4 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -155,6 +155,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -208,6 +212,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -708,6 +716,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. @@ -761,6 +773,10 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "publishToChronicle": { # Message expressing intention to publish to Google Security Operations. # Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + }, + "publishToScc": { # If set, a summary finding will be created/updated in SCC for each profile. # Publishes findings to SCC for each data profile. + }, "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html index 46e485c7d12..835bbb26a15 100644 --- a/docs/dyn/drive_v3.files.html +++ b/docs/dyn/drive_v3.files.html @@ -86,6 +86,9 @@

Instance Methods

delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)

Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.

+

+ download(fileId, mimeType=None, revisionId=None, x__xgafv=None)

+

Downloads content of a file. Operations are valid for 24 hours from the time of creation.

emptyTrash(driveId=None, enforceSingleParent=None, x__xgafv=None)

Permanently deletes all of the user's trashed files.

@@ -1321,6 +1324,43 @@

Method Details

+
+ download(fileId, mimeType=None, revisionId=None, x__xgafv=None) +
Downloads content of a file. Operations are valid for 24 hours from the time of creation.
+
+Args:
+  fileId: string, Required. The ID of the file to download. (required)
+  mimeType: string, Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. See [Export MIME types for Google Workspace documents](/drive/api/guides/ref-export-formats) for the list of supported MIME types. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.
+  revisionId: string, Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.
+  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.
+  },
+}
+
+
emptyTrash(driveId=None, enforceSingleParent=None, x__xgafv=None)
Permanently deletes all of the user's trashed files.
diff --git a/docs/dyn/drive_v3.html b/docs/dyn/drive_v3.html
index f614d6e3f58..8e33494b320 100644
--- a/docs/dyn/drive_v3.html
+++ b/docs/dyn/drive_v3.html
@@ -109,6 +109,16 @@ 

Instance Methods

Returns the files Resource.

+

+ operation() +

+

Returns the operation Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+

permissions()

diff --git a/docs/dyn/drive_v3.operation.html b/docs/dyn/drive_v3.operation.html new file mode 100644 index 00000000000..9b47ad33a67 --- /dev/null +++ b/docs/dyn/drive_v3.operation.html @@ -0,0 +1,118 @@ + + + +

Google Drive API . operation

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/drive_v3.operations.html b/docs/dyn/drive_v3.operations.html new file mode 100644 index 00000000000..4a5a488b83e --- /dev/null +++ b/docs/dyn/drive_v3.operations.html @@ -0,0 +1,187 @@ + + + +

Google Drive API . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

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

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  filter: string, The standard list filter.
+  name: string, The name of the operation's parent resource.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/file_v1.projects.locations.instances.html b/docs/dyn/file_v1.projects.locations.instances.html index 7291f727006..c27a00a6ea7 100644 --- a/docs/dyn/file_v1.projects.locations.instances.html +++ b/docs/dyn/file_v1.projects.locations.instances.html @@ -125,6 +125,7 @@

Method Details

The object takes the form of: { # A Filestore instance. + "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. @@ -166,6 +167,20 @@

Method Details

"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], + "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. + "fixedIops": { # Fixed IOPS (input/output operations per second) 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. + }, + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + }, + }, + "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. + "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. + "maxWriteIops": "A String", # Output only. The max write IOPS. + "maxWriteThroughputBps": "A String", # Output only. The max write throughput in bytes per second. + }, "protocol": "A String", # Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`. "replication": { # Replication specifications. # Optional. Replication configuration. "replicas": [ # Optional. Replication configuration for the replica instance associated with this instance. Only a single replica is supported. @@ -274,6 +289,7 @@

Method Details

An object of the form: { # A Filestore instance. + "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. @@ -315,6 +331,20 @@

Method Details

"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], + "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. + "fixedIops": { # Fixed IOPS (input/output operations per second) 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. + }, + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + }, + }, + "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. + "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. + "maxWriteIops": "A String", # Output only. The max write IOPS. + "maxWriteThroughputBps": "A String", # Output only. The max write throughput in bytes per second. + }, "protocol": "A String", # Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`. "replication": { # Replication specifications. # Optional. Replication configuration. "replicas": [ # Optional. Replication configuration for the replica instance associated with this instance. Only a single replica is supported. @@ -364,6 +394,7 @@

Method Details

{ # ListInstancesResponse is the result of ListInstancesRequest. "instances": [ # A list of instances in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of instances from all locations. If any location is unreachable, the response will only return instances in reachable locations and the "unreachable" field will be populated with a list of unreachable locations. { # A Filestore instance. + "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. @@ -405,6 +436,20 @@

Method Details

"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], + "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. + "fixedIops": { # Fixed IOPS (input/output operations per second) 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. + }, + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + }, + }, + "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. + "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. + "maxWriteIops": "A String", # Output only. The max write IOPS. + "maxWriteThroughputBps": "A String", # Output only. The max write throughput in bytes per second. + }, "protocol": "A String", # Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`. "replication": { # Replication specifications. # Optional. Replication configuration. "replicas": [ # Optional. Replication configuration for the replica instance associated with this instance. Only a single replica is supported. @@ -463,6 +508,7 @@

Method Details

The object takes the form of: { # A Filestore instance. + "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. @@ -504,6 +550,20 @@

Method Details

"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], + "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. + "fixedIops": { # Fixed IOPS (input/output operations per second) 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. + }, + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + }, + }, + "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. + "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. + "maxWriteIops": "A String", # Output only. The max write IOPS. + "maxWriteThroughputBps": "A String", # Output only. The max write throughput in bytes per second. + }, "protocol": "A String", # Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`. "replication": { # Replication specifications. # Optional. Replication configuration. "replicas": [ # Optional. Replication configuration for the replica instance associated with this instance. Only a single replica is supported. diff --git a/docs/dyn/file_v1beta1.projects.locations.backups.html b/docs/dyn/file_v1beta1.projects.locations.backups.html index ed1bdab6891..4cd67d9d475 100644 --- a/docs/dyn/file_v1beta1.projects.locations.backups.html +++ b/docs/dyn/file_v1beta1.projects.locations.backups.html @@ -128,7 +128,7 @@

Method Details

"sourceInstanceTier": "A String", # Output only. The service tier of the source Filestore instance that this backup is created from. "state": "A String", # Output only. The backup state. "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, } @@ -230,7 +230,7 @@

Method Details

"sourceInstanceTier": "A String", # Output only. The service tier of the source Filestore instance that this backup is created from. "state": "A String", # Output only. The backup state. "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, }
@@ -274,7 +274,7 @@

Method Details

"sourceInstanceTier": "A String", # Output only. The service tier of the source Filestore instance that this backup is created from. "state": "A String", # Output only. The backup state. "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, }, @@ -327,7 +327,7 @@

Method Details

"sourceInstanceTier": "A String", # Output only. The service tier of the source Filestore instance that this backup is created from. "state": "A String", # Output only. The backup state. "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, } diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.html b/docs/dyn/file_v1beta1.projects.locations.instances.html index 227a9ce2283..64429e087f7 100644 --- a/docs/dyn/file_v1beta1.projects.locations.instances.html +++ b/docs/dyn/file_v1beta1.projects.locations.instances.html @@ -107,7 +107,7 @@

Instance Methods

Updates the settings of a specific instance.

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

-

Promote an standby instance (replica).

+

Promote the standby instance (replica).

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

Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).

@@ -132,11 +132,14 @@

Method Details

{ # A Filestore instance. "capacityGb": "A String", # The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to `max_capacity_gb` GB in multipliers of `capacity_step_size_gb` GB. "capacityStepSizeGb": "A String", # Output only. The increase/decrease capacity step size. + "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. + "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). "directoryServices": { # Directory Services configuration for Kerberos-based authentication. # Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". - "managedActiveDirectory": { # ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Active Directory. # Configuration for Managed Service for Microsoft Active Directory. - "computer": "A String", # Required. The computer name is used as a prefix to the mount remote target. Example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `. + "managedActiveDirectory": { # ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Service for Microsoft Active Directory (Managed Microsoft AD). # Configuration for Managed Service for Microsoft Active Directory. + "computer": "A String", # Required. The computer name is used as a prefix in the command to mount the remote target. For example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `. "domain": "A String", # Required. The domain resource name, in the format `projects/{project_id}/locations/global/domains/{domain}`. }, }, @@ -183,9 +186,23 @@

Method Details

"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], + "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. + "fixedIops": { # Fixed IOPS (input/output operations per second) 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. + }, + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + }, + }, + "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. + "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. + "maxWriteIops": "A String", # Output only. The max write IOPS. + "maxWriteThroughputBps": "A String", # Output only. The max write throughput in bytes per second. + }, "protocol": "A String", # Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`. - "replication": { # Replication specifications. # Optional. Replicaition configuration. - "replicas": [ # Replicas configuration on the instance. For now, only a single replica config is supported. + "replication": { # Replication specifications. # Optional. Replication configuration. + "replicas": [ # Replication configuration for the replica instance associated with this instance. Only a single replica is supported. { # Replica configuration for the instance. "lastActiveSyncTime": "A String", # Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely. "peerInstance": "A String", # The peer instance. @@ -204,7 +221,7 @@

Method Details

"suspensionReasons": [ # Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. "A String", ], - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, "tier": "A String", # The service tier of the instance. @@ -293,11 +310,14 @@

Method Details

{ # A Filestore instance. "capacityGb": "A String", # The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to `max_capacity_gb` GB in multipliers of `capacity_step_size_gb` GB. "capacityStepSizeGb": "A String", # Output only. The increase/decrease capacity step size. + "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. + "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). "directoryServices": { # Directory Services configuration for Kerberos-based authentication. # Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". - "managedActiveDirectory": { # ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Active Directory. # Configuration for Managed Service for Microsoft Active Directory. - "computer": "A String", # Required. The computer name is used as a prefix to the mount remote target. Example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `. + "managedActiveDirectory": { # ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Service for Microsoft Active Directory (Managed Microsoft AD). # Configuration for Managed Service for Microsoft Active Directory. + "computer": "A String", # Required. The computer name is used as a prefix in the command to mount the remote target. For example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `. "domain": "A String", # Required. The domain resource name, in the format `projects/{project_id}/locations/global/domains/{domain}`. }, }, @@ -344,9 +364,23 @@

Method Details

"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], + "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. + "fixedIops": { # Fixed IOPS (input/output operations per second) 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. + }, + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + }, + }, + "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. + "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. + "maxWriteIops": "A String", # Output only. The max write IOPS. + "maxWriteThroughputBps": "A String", # Output only. The max write throughput in bytes per second. + }, "protocol": "A String", # Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`. - "replication": { # Replication specifications. # Optional. Replicaition configuration. - "replicas": [ # Replicas configuration on the instance. For now, only a single replica config is supported. + "replication": { # Replication specifications. # Optional. Replication configuration. + "replicas": [ # Replication configuration for the replica instance associated with this instance. Only a single replica is supported. { # Replica configuration for the instance. "lastActiveSyncTime": "A String", # Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely. "peerInstance": "A String", # The peer instance. @@ -365,7 +399,7 @@

Method Details

"suspensionReasons": [ # Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. "A String", ], - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, "tier": "A String", # The service tier of the instance. @@ -395,11 +429,14 @@

Method Details

{ # A Filestore instance. "capacityGb": "A String", # The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to `max_capacity_gb` GB in multipliers of `capacity_step_size_gb` GB. "capacityStepSizeGb": "A String", # Output only. The increase/decrease capacity step size. + "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. + "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). "directoryServices": { # Directory Services configuration for Kerberos-based authentication. # Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". - "managedActiveDirectory": { # ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Active Directory. # Configuration for Managed Service for Microsoft Active Directory. - "computer": "A String", # Required. The computer name is used as a prefix to the mount remote target. Example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `. + "managedActiveDirectory": { # ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Service for Microsoft Active Directory (Managed Microsoft AD). # Configuration for Managed Service for Microsoft Active Directory. + "computer": "A String", # Required. The computer name is used as a prefix in the command to mount the remote target. For example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `. "domain": "A String", # Required. The domain resource name, in the format `projects/{project_id}/locations/global/domains/{domain}`. }, }, @@ -446,9 +483,23 @@

Method Details

"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], + "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. + "fixedIops": { # Fixed IOPS (input/output operations per second) 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. + }, + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + }, + }, + "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. + "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. + "maxWriteIops": "A String", # Output only. The max write IOPS. + "maxWriteThroughputBps": "A String", # Output only. The max write throughput in bytes per second. + }, "protocol": "A String", # Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`. - "replication": { # Replication specifications. # Optional. Replicaition configuration. - "replicas": [ # Replicas configuration on the instance. For now, only a single replica config is supported. + "replication": { # Replication specifications. # Optional. Replication configuration. + "replicas": [ # Replication configuration for the replica instance associated with this instance. Only a single replica is supported. { # Replica configuration for the instance. "lastActiveSyncTime": "A String", # Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely. "peerInstance": "A String", # The peer instance. @@ -467,7 +518,7 @@

Method Details

"suspensionReasons": [ # Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. "A String", ], - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, "tier": "A String", # The service tier of the instance. @@ -506,11 +557,14 @@

Method Details

{ # A Filestore instance. "capacityGb": "A String", # The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to `max_capacity_gb` GB in multipliers of `capacity_step_size_gb` GB. "capacityStepSizeGb": "A String", # Output only. The increase/decrease capacity step size. + "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. + "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). "directoryServices": { # Directory Services configuration for Kerberos-based authentication. # Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". - "managedActiveDirectory": { # ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Active Directory. # Configuration for Managed Service for Microsoft Active Directory. - "computer": "A String", # Required. The computer name is used as a prefix to the mount remote target. Example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `. + "managedActiveDirectory": { # ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Service for Microsoft Active Directory (Managed Microsoft AD). # Configuration for Managed Service for Microsoft Active Directory. + "computer": "A String", # Required. The computer name is used as a prefix in the command to mount the remote target. For example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `. "domain": "A String", # Required. The domain resource name, in the format `projects/{project_id}/locations/global/domains/{domain}`. }, }, @@ -557,9 +611,23 @@

Method Details

"reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. }, ], + "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Used to configure performance. + "fixedIops": { # Fixed IOPS (input/output operations per second) 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. + }, + "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + "maxReadIopsPerTb": "A String", # Required. Maximum read IOPS per TiB. + }, + }, + "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. + "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. + "maxWriteIops": "A String", # Output only. The max write IOPS. + "maxWriteThroughputBps": "A String", # Output only. The max write throughput in bytes per second. + }, "protocol": "A String", # Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`. - "replication": { # Replication specifications. # Optional. Replicaition configuration. - "replicas": [ # Replicas configuration on the instance. For now, only a single replica config is supported. + "replication": { # Replication specifications. # Optional. Replication configuration. + "replicas": [ # Replication configuration for the replica instance associated with this instance. Only a single replica is supported. { # Replica configuration for the instance. "lastActiveSyncTime": "A String", # Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely. "peerInstance": "A String", # The peer instance. @@ -578,13 +646,13 @@

Method Details

"suspensionReasons": [ # Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. "A String", ], - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, "tier": "A String", # The service tier of the instance. } - updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "directory_services" * "file_shares" * "labels" + updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "directory_services" * "file_shares" * "labels" * "performance_config" * "deletion_protection_enabled" * "deletion_protection_reason" x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -616,7 +684,7 @@

Method Details

promoteReplica(name, body=None, x__xgafv=None) -
Promote an standby instance (replica).
+  
Promote the standby instance (replica).
 
 Args:
   name: string, Required. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. (required)
diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.snapshots.html b/docs/dyn/file_v1beta1.projects.locations.instances.snapshots.html
index 49bd55716e0..bfc83103a23 100644
--- a/docs/dyn/file_v1beta1.projects.locations.instances.snapshots.html
+++ b/docs/dyn/file_v1beta1.projects.locations.instances.snapshots.html
@@ -119,7 +119,7 @@ 

Method Details

}, "name": "A String", # Output only. The resource name of the snapshot, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}`. "state": "A String", # Output only. The snapshot state. - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, } @@ -212,7 +212,7 @@

Method Details

}, "name": "A String", # Output only. The resource name of the snapshot, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}`. "state": "A String", # Output only. The snapshot state. - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, }
@@ -248,7 +248,7 @@

Method Details

}, "name": "A String", # Output only. The resource name of the snapshot, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}`. "state": "A String", # Output only. The snapshot state. - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, }, @@ -288,7 +288,7 @@

Method Details

}, "name": "A String", # Output only. The resource name of the snapshot, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}`. "state": "A String", # Output only. The snapshot state. - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, } diff --git a/docs/dyn/gkehub_v1.projects.locations.features.html b/docs/dyn/gkehub_v1.projects.locations.features.html index 83d2eb9b309..55f726c64cb 100644 --- a/docs/dyn/gkehub_v1.projects.locations.features.html +++ b/docs/dyn/gkehub_v1.projects.locations.features.html @@ -249,7 +249,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -446,7 +450,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -766,7 +774,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member @@ -1190,7 +1202,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -1387,7 +1403,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -1707,7 +1727,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member @@ -2119,7 +2143,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -2316,7 +2344,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -2636,7 +2668,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member @@ -3003,7 +3039,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -3200,7 +3240,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -3520,7 +3564,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.features.html index 51fdb42631c..10277bc6db6 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.features.html @@ -252,7 +252,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -463,7 +467,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -802,7 +810,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member @@ -1356,7 +1368,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -1567,7 +1583,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -1906,7 +1926,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member @@ -2448,7 +2472,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -2659,7 +2687,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -2998,7 +3030,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member @@ -3495,7 +3531,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -3706,7 +3746,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -4045,7 +4089,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member diff --git a/docs/dyn/gkehub_v1beta.projects.locations.features.html b/docs/dyn/gkehub_v1beta.projects.locations.features.html index bf3fa300bf6..ab54d9fe728 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.features.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.features.html @@ -252,7 +252,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -461,7 +465,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -790,7 +798,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member @@ -1229,7 +1241,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -1438,7 +1454,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -1767,7 +1787,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member @@ -2194,7 +2218,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -2403,7 +2431,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -2732,7 +2764,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member @@ -3114,7 +3150,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -3323,7 +3363,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec @@ -3652,7 +3696,11 @@

Method Details

}, ], "identityServiceOptions": { # Holds non-protocol-related configuration options. # Optional. non-protocol-related configuration options. - "sessionDuration": "A String", # Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + "diagnosticInterface": { # Configuration options for the AIS diagnostic interface. # Configuration options for the AIS diagnostic interface. + "enabled": True or False, # Determines whether to enable the diagnostic interface. + "expirationTime": "A String", # Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + }, + "sessionDuration": "A String", # Determines the lifespan of STS tokens issued by Anthos Identity Service. }, }, "state": "A String", # Deployment state on this member diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html index 3ff8a9e4fb9..46c8ec3eddb 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html @@ -74,6 +74,18 @@

Cloud Healthcare API . projects . locations . datasets . fhirStores . fhir

Instance Methods

+

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

+

Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

+

+ Binary_read(name, x__xgafv=None)

+

Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

+

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

+

Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

+

+ Binary_vread(name, x__xgafv=None)

+

Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

Patient_everything(name, end=None, start=None, x__xgafv=None, x_count=None, x_page_token=None, x_since=None, x_type=None)

Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).

@@ -129,6 +141,132 @@

Instance Methods

vread(name, x__xgafv=None)

Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#vread), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).

Method Details

+
+ Binary_create(parent, body=None, x__xgafv=None) +
Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
+
+Args:
+  parent: string, Required. The name of the FHIR store this resource belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ +
+ Binary_read(name, x__xgafv=None) +
Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
+
+Args:
+  name: string, Required. The name of the Binary resource 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:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ +
+ Binary_update(name, body=None, x__xgafv=None) +
Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
+
+Args:
+  name: string, Required. The name of the resource to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ +
+ Binary_vread(name, x__xgafv=None) +
Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
+
+Args:
+  name: string, Required. The name of the Binary resource version 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:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
Patient_everything(name, end=None, start=None, x__xgafv=None, x_count=None, x_page_token=None, x_since=None, x_type=None)
Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html
index bdd51a8a71d..474fc71dc86 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html
@@ -74,6 +74,18 @@
 
 

Cloud Healthcare API . projects . locations . datasets . fhirStores . fhir

Instance Methods

+

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

+

Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

+

+ Binary_read(name, x__xgafv=None)

+

Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

+

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

+

Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

+

+ Binary_vread(name, x__xgafv=None)

+

Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

ConceptMap_search_translate(parent, code=None, conceptMapVersion=None, source=None, system=None, target=None, url=None, x__xgafv=None)

Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

@@ -150,6 +162,132 @@

Instance Methods

vread(name, x__xgafv=None)

Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#vread), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).

Method Details

+
+ Binary_create(parent, body=None, x__xgafv=None) +
Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
+
+Args:
+  parent: string, Required. The name of the FHIR store this resource belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ +
+ Binary_read(name, x__xgafv=None) +
Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
+
+Args:
+  name: string, Required. The name of the Binary resource 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:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ +
+ Binary_update(name, body=None, x__xgafv=None) +
Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
+
+Args:
+  name: string, Required. The name of the resource to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ +
+ Binary_vread(name, x__xgafv=None) +
Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.
+
+Args:
+  name: string, Required. The name of the Binary resource version 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:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
ConceptMap_search_translate(parent, code=None, conceptMapVersion=None, source=None, system=None, target=None, url=None, x__xgafv=None)
Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.
diff --git a/docs/dyn/index.md b/docs/dyn/index.md
index 7a895259494..a819c7f4f4f 100644
--- a/docs/dyn/index.md
+++ b/docs/dyn/index.md
@@ -818,6 +818,7 @@
 * [promotions_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_promotions_v1beta.html)
 * [quota_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_quota_v1beta.html)
 * [reports_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_reports_v1beta.html)
+* [reviews_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_reviews_v1beta.html)
 
 
 ## metastore
diff --git a/docs/dyn/integrations_v1.projects.locations.connections.html b/docs/dyn/integrations_v1.projects.locations.connections.html
index 89bd02d41d5..aa030ff6c32 100644
--- a/docs/dyn/integrations_v1.projects.locations.connections.html
+++ b/docs/dyn/integrations_v1.projects.locations.connections.html
@@ -180,6 +180,13 @@ 

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -318,6 +325,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -389,6 +403,13 @@

Method Details

"A String", ], }, + "oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged. + "authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens. + "redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange. + "scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. "clientId": "A String", # The client identifier. "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. @@ -537,6 +558,7 @@

Method Details

}, "subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project. "suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not. + "tlsMigrationState": "A String", # Output only. Status of the TLS migration. "tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS. "updateTime": "A String", # Output only. Updated time. }, diff --git a/docs/dyn/logging_v2.projects.metrics.html b/docs/dyn/logging_v2.projects.metrics.html index bf172eac280..58f03eef797 100644 --- a/docs/dyn/logging_v2.projects.metrics.html +++ b/docs/dyn/logging_v2.projects.metrics.html @@ -151,6 +151,9 @@

Method Details

"ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. + "timeSeriesResourceHierarchyLevel": [ # The scope of the timeseries data of the metric. + "A String", + ], }, "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. @@ -217,6 +220,9 @@

Method Details

"ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. + "timeSeriesResourceHierarchyLevel": [ # The scope of the timeseries data of the metric. + "A String", + ], }, "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. @@ -308,6 +314,9 @@

Method Details

"ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. + "timeSeriesResourceHierarchyLevel": [ # The scope of the timeseries data of the metric. + "A String", + ], }, "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. @@ -385,6 +394,9 @@

Method Details

"ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. + "timeSeriesResourceHierarchyLevel": [ # The scope of the timeseries data of the metric. + "A String", + ], }, "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. @@ -470,6 +482,9 @@

Method Details

"ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. + "timeSeriesResourceHierarchyLevel": [ # The scope of the timeseries data of the metric. + "A String", + ], }, "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. @@ -536,6 +551,9 @@

Method Details

"ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. + "timeSeriesResourceHierarchyLevel": [ # The scope of the timeseries data of the metric. + "A String", + ], }, "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html index 0b50e7dc2ee..785dbbdd6aa 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html @@ -103,7 +103,7 @@

Method Details

Returns: An object of the form: - { # The merchant account's [shipping setting]((https://support.google.com/merchants/answer/6069284). + { # 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. @@ -421,7 +421,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The merchant account's [shipping setting]((https://support.google.com/merchants/answer/6069284). +{ # 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. @@ -737,7 +737,7 @@

Method Details

Returns: An object of the form: - { # The merchant account's [shipping setting]((https://support.google.com/merchants/answer/6069284). + { # 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. diff --git a/docs/dyn/migrationcenter_v1.projects.locations.assets.html b/docs/dyn/migrationcenter_v1.projects.locations.assets.html index 71ea5713776..4011ea2b394 100644 --- a/docs/dyn/migrationcenter_v1.projects.locations.assets.html +++ b/docs/dyn/migrationcenter_v1.projects.locations.assets.html @@ -232,21 +232,21 @@

Method Details

"migrationInsight": { # An insight about potential migrations for an asset. # Output only. An insight about potential migrations for an asset. "computeEngineTarget": { # Compute engine migration target. # Output only. A Google Compute Engine target. "shape": { # Compute Engine target shape descriptor. # Description of the suggested shape for the migration target. - "logicalCoreCount": 42, # Number of logical cores. - "machineType": "A String", # Compute Engine machine type. + "logicalCoreCount": 42, # Output only. Number of logical cores. + "machineType": "A String", # Output only. Compute Engine machine type. "memoryMb": 42, # Memory in mebibytes. "physicalCoreCount": 42, # Number of physical cores. - "series": "A String", # Compute Engine machine series. - "storage": [ # Compute Engine storage. Never empty. + "series": "A String", # Output only. Compute Engine machine series. + "storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. - "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "sizeGb": 42, # Output only. Disk size in GiB. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, }, }, @@ -573,21 +573,21 @@

Method Details

"migrationInsight": { # An insight about potential migrations for an asset. # Output only. An insight about potential migrations for an asset. "computeEngineTarget": { # Compute engine migration target. # Output only. A Google Compute Engine target. "shape": { # Compute Engine target shape descriptor. # Description of the suggested shape for the migration target. - "logicalCoreCount": 42, # Number of logical cores. - "machineType": "A String", # Compute Engine machine type. + "logicalCoreCount": 42, # Output only. Number of logical cores. + "machineType": "A String", # Output only. Compute Engine machine type. "memoryMb": 42, # Memory in mebibytes. "physicalCoreCount": 42, # Number of physical cores. - "series": "A String", # Compute Engine machine series. - "storage": [ # Compute Engine storage. Never empty. + "series": "A String", # Output only. Compute Engine machine series. + "storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. - "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "sizeGb": 42, # Output only. Disk size in GiB. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, }, }, @@ -945,21 +945,21 @@

Method Details

"migrationInsight": { # An insight about potential migrations for an asset. # Output only. An insight about potential migrations for an asset. "computeEngineTarget": { # Compute engine migration target. # Output only. A Google Compute Engine target. "shape": { # Compute Engine target shape descriptor. # Description of the suggested shape for the migration target. - "logicalCoreCount": 42, # Number of logical cores. - "machineType": "A String", # Compute Engine machine type. + "logicalCoreCount": 42, # Output only. Number of logical cores. + "machineType": "A String", # Output only. Compute Engine machine type. "memoryMb": 42, # Memory in mebibytes. "physicalCoreCount": 42, # Number of physical cores. - "series": "A String", # Compute Engine machine series. - "storage": [ # Compute Engine storage. Never empty. + "series": "A String", # Output only. Compute Engine machine series. + "storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. - "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "sizeGb": 42, # Output only. Disk size in GiB. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, }, }, @@ -1297,21 +1297,21 @@

Method Details

"migrationInsight": { # An insight about potential migrations for an asset. # Output only. An insight about potential migrations for an asset. "computeEngineTarget": { # Compute engine migration target. # Output only. A Google Compute Engine target. "shape": { # Compute Engine target shape descriptor. # Description of the suggested shape for the migration target. - "logicalCoreCount": 42, # Number of logical cores. - "machineType": "A String", # Compute Engine machine type. + "logicalCoreCount": 42, # Output only. Number of logical cores. + "machineType": "A String", # Output only. Compute Engine machine type. "memoryMb": 42, # Memory in mebibytes. "physicalCoreCount": 42, # Number of physical cores. - "series": "A String", # Compute Engine machine series. - "storage": [ # Compute Engine storage. Never empty. + "series": "A String", # Output only. Compute Engine machine series. + "storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. - "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "sizeGb": 42, # Output only. Disk size in GiB. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, }, }, @@ -1653,21 +1653,21 @@

Method Details

"migrationInsight": { # An insight about potential migrations for an asset. # Output only. An insight about potential migrations for an asset. "computeEngineTarget": { # Compute engine migration target. # Output only. A Google Compute Engine target. "shape": { # Compute Engine target shape descriptor. # Description of the suggested shape for the migration target. - "logicalCoreCount": 42, # Number of logical cores. - "machineType": "A String", # Compute Engine machine type. + "logicalCoreCount": 42, # Output only. Number of logical cores. + "machineType": "A String", # Output only. Compute Engine machine type. "memoryMb": 42, # Memory in mebibytes. "physicalCoreCount": 42, # Number of physical cores. - "series": "A String", # Compute Engine machine series. - "storage": [ # Compute Engine storage. Never empty. + "series": "A String", # Output only. Compute Engine machine series. + "storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. - "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "sizeGb": 42, # Output only. Disk size in GiB. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, }, }, @@ -1989,21 +1989,21 @@

Method Details

"migrationInsight": { # An insight about potential migrations for an asset. # Output only. An insight about potential migrations for an asset. "computeEngineTarget": { # Compute engine migration target. # Output only. A Google Compute Engine target. "shape": { # Compute Engine target shape descriptor. # Description of the suggested shape for the migration target. - "logicalCoreCount": 42, # Number of logical cores. - "machineType": "A String", # Compute Engine machine type. + "logicalCoreCount": 42, # Output only. Number of logical cores. + "machineType": "A String", # Output only. Compute Engine machine type. "memoryMb": 42, # Memory in mebibytes. "physicalCoreCount": 42, # Number of physical cores. - "series": "A String", # Compute Engine machine series. - "storage": [ # Compute Engine storage. Never empty. + "series": "A String", # Output only. Compute Engine machine series. + "storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. - "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "sizeGb": 42, # Output only. Disk size in GiB. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, }, }, diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html index 68fd7e9a661..7cc06d982ef 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html @@ -389,12 +389,12 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. MySQL version to be used on the Cloud SQL for MySQL instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. }, - "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for Postgres database shape. + "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for PostgreSQL database shape. "backupStorageGb": 42, # Output only. Predicted backup storage size in GiB. "edition": "A String", # Output only. Cloud SQL edition. "egressGbPerMonth": "A String", # Output only. Predicted Network Out traffic GiB per month. @@ -402,7 +402,7 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. PostgreSql version to be used on the Cloud SQL for PostgreSql instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -416,7 +416,7 @@

Method Details

"smtEnabled": True or False, # Output only. Whether simultaneous multithreading is enabled (see https://cloud.google.com/sql/docs/sqlserver/create-instance#smt-create-instance). "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. Microsoft SQL Server version to be used on the Cloud SQL for SQL server instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -435,13 +435,13 @@

Method Details

"storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, "gkeTarget": { # GKE migration target. # Output only. A Google Kubernetes Engine target. }, @@ -474,7 +474,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The full name of the asset. - "performanceData": { # Performance data for an asset. # Output only. Performance data for the asset. + "performanceData": { # Performance data for an asset. # Performance data for the asset. "dailyResourceUsageAggregations": [ # Daily resource usage aggregations. Contains all of the data available for an asset, up to the last 420 days. Aggregations are sorted from oldest to most recent. { # Usage data aggregation for a single day. "cpu": { # Statistical aggregation of CPU usage. # CPU usage. @@ -557,8 +557,8 @@

Method Details

}, ], }, - "hosts": { # Hosts content. # Hosts file (/etc/hosts). - "entries": [ # Hosts entries. + "hosts": { # Hosts content. # Output only. Hosts file (/etc/hosts). + "entries": [ # Output only. Hosts entries. { # Single /etc/hosts entry. "hostNames": [ # List of host names / aliases. "A String", @@ -974,12 +974,12 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. MySQL version to be used on the Cloud SQL for MySQL instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. }, - "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for Postgres database shape. + "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for PostgreSQL database shape. "backupStorageGb": 42, # Output only. Predicted backup storage size in GiB. "edition": "A String", # Output only. Cloud SQL edition. "egressGbPerMonth": "A String", # Output only. Predicted Network Out traffic GiB per month. @@ -987,7 +987,7 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. PostgreSql version to be used on the Cloud SQL for PostgreSql instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -1001,7 +1001,7 @@

Method Details

"smtEnabled": True or False, # Output only. Whether simultaneous multithreading is enabled (see https://cloud.google.com/sql/docs/sqlserver/create-instance#smt-create-instance). "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. Microsoft SQL Server version to be used on the Cloud SQL for SQL server instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -1020,13 +1020,13 @@

Method Details

"storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, "gkeTarget": { # GKE migration target. # Output only. A Google Kubernetes Engine target. }, @@ -1059,7 +1059,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The full name of the asset. - "performanceData": { # Performance data for an asset. # Output only. Performance data for the asset. + "performanceData": { # Performance data for an asset. # Performance data for the asset. "dailyResourceUsageAggregations": [ # Daily resource usage aggregations. Contains all of the data available for an asset, up to the last 420 days. Aggregations are sorted from oldest to most recent. { # Usage data aggregation for a single day. "cpu": { # Statistical aggregation of CPU usage. # CPU usage. @@ -1142,8 +1142,8 @@

Method Details

}, ], }, - "hosts": { # Hosts content. # Hosts file (/etc/hosts). - "entries": [ # Hosts entries. + "hosts": { # Hosts content. # Output only. Hosts file (/etc/hosts). + "entries": [ # Output only. Hosts entries. { # Single /etc/hosts entry. "hostNames": [ # List of host names / aliases. "A String", @@ -1591,12 +1591,12 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. MySQL version to be used on the Cloud SQL for MySQL instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. }, - "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for Postgres database shape. + "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for PostgreSQL database shape. "backupStorageGb": 42, # Output only. Predicted backup storage size in GiB. "edition": "A String", # Output only. Cloud SQL edition. "egressGbPerMonth": "A String", # Output only. Predicted Network Out traffic GiB per month. @@ -1604,7 +1604,7 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. PostgreSql version to be used on the Cloud SQL for PostgreSql instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -1618,7 +1618,7 @@

Method Details

"smtEnabled": True or False, # Output only. Whether simultaneous multithreading is enabled (see https://cloud.google.com/sql/docs/sqlserver/create-instance#smt-create-instance). "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. Microsoft SQL Server version to be used on the Cloud SQL for SQL server instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -1637,13 +1637,13 @@

Method Details

"storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, "gkeTarget": { # GKE migration target. # Output only. A Google Kubernetes Engine target. }, @@ -1676,7 +1676,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The full name of the asset. - "performanceData": { # Performance data for an asset. # Output only. Performance data for the asset. + "performanceData": { # Performance data for an asset. # Performance data for the asset. "dailyResourceUsageAggregations": [ # Daily resource usage aggregations. Contains all of the data available for an asset, up to the last 420 days. Aggregations are sorted from oldest to most recent. { # Usage data aggregation for a single day. "cpu": { # Statistical aggregation of CPU usage. # CPU usage. @@ -1759,8 +1759,8 @@

Method Details

}, ], }, - "hosts": { # Hosts content. # Hosts file (/etc/hosts). - "entries": [ # Hosts entries. + "hosts": { # Hosts content. # Output only. Hosts file (/etc/hosts). + "entries": [ # Output only. Hosts entries. { # Single /etc/hosts entry. "hostNames": [ # List of host names / aliases. "A String", @@ -2189,12 +2189,12 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. MySQL version to be used on the Cloud SQL for MySQL instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. }, - "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for Postgres database shape. + "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for PostgreSQL database shape. "backupStorageGb": 42, # Output only. Predicted backup storage size in GiB. "edition": "A String", # Output only. Cloud SQL edition. "egressGbPerMonth": "A String", # Output only. Predicted Network Out traffic GiB per month. @@ -2202,7 +2202,7 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. PostgreSql version to be used on the Cloud SQL for PostgreSql instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -2216,7 +2216,7 @@

Method Details

"smtEnabled": True or False, # Output only. Whether simultaneous multithreading is enabled (see https://cloud.google.com/sql/docs/sqlserver/create-instance#smt-create-instance). "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. Microsoft SQL Server version to be used on the Cloud SQL for SQL server instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -2235,13 +2235,13 @@

Method Details

"storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, "gkeTarget": { # GKE migration target. # Output only. A Google Kubernetes Engine target. }, @@ -2274,7 +2274,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The full name of the asset. - "performanceData": { # Performance data for an asset. # Output only. Performance data for the asset. + "performanceData": { # Performance data for an asset. # Performance data for the asset. "dailyResourceUsageAggregations": [ # Daily resource usage aggregations. Contains all of the data available for an asset, up to the last 420 days. Aggregations are sorted from oldest to most recent. { # Usage data aggregation for a single day. "cpu": { # Statistical aggregation of CPU usage. # CPU usage. @@ -2357,8 +2357,8 @@

Method Details

}, ], }, - "hosts": { # Hosts content. # Hosts file (/etc/hosts). - "entries": [ # Hosts entries. + "hosts": { # Hosts content. # Output only. Hosts file (/etc/hosts). + "entries": [ # Output only. Hosts entries. { # Single /etc/hosts entry. "hostNames": [ # List of host names / aliases. "A String", @@ -2789,12 +2789,12 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. MySQL version to be used on the Cloud SQL for MySQL instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. }, - "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for Postgres database shape. + "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for PostgreSQL database shape. "backupStorageGb": 42, # Output only. Predicted backup storage size in GiB. "edition": "A String", # Output only. Cloud SQL edition. "egressGbPerMonth": "A String", # Output only. Predicted Network Out traffic GiB per month. @@ -2802,7 +2802,7 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. PostgreSql version to be used on the Cloud SQL for PostgreSql instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -2816,7 +2816,7 @@

Method Details

"smtEnabled": True or False, # Output only. Whether simultaneous multithreading is enabled (see https://cloud.google.com/sql/docs/sqlserver/create-instance#smt-create-instance). "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. Microsoft SQL Server version to be used on the Cloud SQL for SQL server instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -2835,13 +2835,13 @@

Method Details

"storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, "gkeTarget": { # GKE migration target. # Output only. A Google Kubernetes Engine target. }, @@ -2874,7 +2874,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The full name of the asset. - "performanceData": { # Performance data for an asset. # Output only. Performance data for the asset. + "performanceData": { # Performance data for an asset. # Performance data for the asset. "dailyResourceUsageAggregations": [ # Daily resource usage aggregations. Contains all of the data available for an asset, up to the last 420 days. Aggregations are sorted from oldest to most recent. { # Usage data aggregation for a single day. "cpu": { # Statistical aggregation of CPU usage. # CPU usage. @@ -2957,8 +2957,8 @@

Method Details

}, ], }, - "hosts": { # Hosts content. # Hosts file (/etc/hosts). - "entries": [ # Hosts entries. + "hosts": { # Hosts content. # Output only. Hosts file (/etc/hosts). + "entries": [ # Output only. Hosts entries. { # Single /etc/hosts entry. "hostNames": [ # List of host names / aliases. "A String", @@ -3369,12 +3369,12 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. MySQL version to be used on the Cloud SQL for MySQL instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. }, - "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for Postgres database shape. + "cloudSqlForPostgresqlShape": { # Cloud SQL for Postgres database shape. # Cloud SQL for PostgreSQL database shape. "backupStorageGb": 42, # Output only. Predicted backup storage size in GiB. "edition": "A String", # Output only. Cloud SQL edition. "egressGbPerMonth": "A String", # Output only. Predicted Network Out traffic GiB per month. @@ -3382,7 +3382,7 @@

Method Details

"memoryMb": 42, # Output only. Predicted amount of memory in MiB. "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. PostgreSql version to be used on the Cloud SQL for PostgreSql instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -3396,7 +3396,7 @@

Method Details

"smtEnabled": True or False, # Output only. Whether simultaneous multithreading is enabled (see https://cloud.google.com/sql/docs/sqlserver/create-instance#smt-create-instance). "storage": { # Compute Engine storage option descriptor. # Output only. Predicted storage shape. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, "version": "A String", # Output only. Microsoft SQL Server version to be used on the Cloud SQL for SQL server instance. "zoneAvailability": "A String", # Output only. Cloud SQL zone availability. @@ -3415,13 +3415,13 @@

Method Details

"storage": [ # Output only. Compute Engine storage. Never empty. { # Compute Engine storage option descriptor. "sizeGb": 42, # Disk size in GiB. - "type": "A String", # Disk type backing the storage. + "type": "A String", # Output only. Disk type backing the storage. }, ], }, }, "fit": { # Describes the fit level of an asset for migration to a specific target. # Output only. Description of how well the asset this insight is associated with fits the proposed migration. - "fitLevel": "A String", # Fit level. + "fitLevel": "A String", # Output only. Fit level. }, "gkeTarget": { # GKE migration target. # Output only. A Google Kubernetes Engine target. }, @@ -3454,7 +3454,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The full name of the asset. - "performanceData": { # Performance data for an asset. # Output only. Performance data for the asset. + "performanceData": { # Performance data for an asset. # Performance data for the asset. "dailyResourceUsageAggregations": [ # Daily resource usage aggregations. Contains all of the data available for an asset, up to the last 420 days. Aggregations are sorted from oldest to most recent. { # Usage data aggregation for a single day. "cpu": { # Statistical aggregation of CPU usage. # CPU usage. @@ -3537,8 +3537,8 @@

Method Details

}, ], }, - "hosts": { # Hosts content. # Hosts file (/etc/hosts). - "entries": [ # Hosts entries. + "hosts": { # Hosts content. # Output only. Hosts file (/etc/hosts). + "entries": [ # Output only. Hosts entries. { # Single /etc/hosts entry. "hostNames": [ # List of host names / aliases. "A String", @@ -3967,8 +3967,8 @@

Method Details

}, ], }, - "hosts": { # Hosts content. # Hosts file (/etc/hosts). - "entries": [ # Hosts entries. + "hosts": { # Hosts content. # Output only. Hosts file (/etc/hosts). + "entries": [ # Output only. Hosts entries. { # Single /etc/hosts entry. "hostNames": [ # List of host names / aliases. "A String", diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assetsExportJobs.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assetsExportJobs.html index 8f0f364be08..14b024b5c38 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assetsExportJobs.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assetsExportJobs.html @@ -115,6 +115,8 @@

Method Details

"filter": "A String", # Optional. Assets filter, supports the same syntax as asset listing. }, "createTime": "A String", # Output only. Resource creation time. + "inventory": { # Configuration for asset inventory details exports. # Export asset inventory details. + }, "labels": { # Optional. Labels as key value pairs. Labels must meet the following constraints: * 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. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, @@ -122,11 +124,15 @@

Method Details

"networkDependencies": { # Configuration for network dependencies exports. # Export data regarding asset network dependencies. "maxDays": 42, # Optional. When this value is set to a positive integer, network connections data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. }, + "performanceData": { # Configuration for performance data exports. # Export asset with performance data. + "maxDays": 42, # Optional. When this value is set to a positive integer, performance data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. The maximum value is 420; values above 420 will be coerced to 420. If unset (0 value) a default value of 40 will be used. + }, "recentExecutions": [ # Output only. Recent non expired executions of the job. { # Execution status of assets export job. "endTime": "A String", # Output only. Completion time of the export. "executionId": "A String", # Output only. Globally unique identifier of the execution. "expireTime": "A String", # Output only. Expiration time for the export and artifacts. + "requestedAssetCount": 42, # Output only. Number of assets requested for export after resolving the requested filters. "result": { # Contains the result of the assets export. # Output only. Result of the export execution. "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. Error encountered during export. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -137,6 +143,21 @@

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. }, + "outputFiles": { # Contains a list of output files. # Output only. List of output files. + "entries": [ # List of output files. + { # Contains a single output file. + "csvOutputFile": { # Contains a single output file of type CSV. # Output only. CSV output file. + "columnsCount": 42, # Output only. Number of columns in the file. + "rowCount": 42, # Output only. Number of rows in the file. + "signedUri": { # Contains a signed URI. # Output only. Signed URI destination. + "file": "A String", # Output only. Name of the file the Signed URI references. + "uri": "A String", # Output only. Download URI for the file. + }, + }, + "fileSizeBytes": 42, # Output only. File size in bytes. + }, + ], + }, "signedUris": { # Contains a list of Signed URIs. # Output only. Signed URLs for downloading export artifacts. "signedUris": [ # Output only. List of signed URIs. { # Contains a signed URI. @@ -149,6 +170,7 @@

Method Details

"startTime": "A String", # Output only. Execution timestamp. }, ], + "showHidden": True or False, # Optional. When this value is set to 'true' the response will include all assets, including those that are hidden. "signedUriDestination": { # Signed URI destination configuration. # Export to Cloud Storage files downloadable using signed URIs. }, "updateTime": "A String", # Output only. Resource update time. @@ -239,6 +261,8 @@

Method Details

"filter": "A String", # Optional. Assets filter, supports the same syntax as asset listing. }, "createTime": "A String", # Output only. Resource creation time. + "inventory": { # Configuration for asset inventory details exports. # Export asset inventory details. + }, "labels": { # Optional. Labels as key value pairs. Labels must meet the following constraints: * 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. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, @@ -246,11 +270,15 @@

Method Details

"networkDependencies": { # Configuration for network dependencies exports. # Export data regarding asset network dependencies. "maxDays": 42, # Optional. When this value is set to a positive integer, network connections data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. }, + "performanceData": { # Configuration for performance data exports. # Export asset with performance data. + "maxDays": 42, # Optional. When this value is set to a positive integer, performance data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. The maximum value is 420; values above 420 will be coerced to 420. If unset (0 value) a default value of 40 will be used. + }, "recentExecutions": [ # Output only. Recent non expired executions of the job. { # Execution status of assets export job. "endTime": "A String", # Output only. Completion time of the export. "executionId": "A String", # Output only. Globally unique identifier of the execution. "expireTime": "A String", # Output only. Expiration time for the export and artifacts. + "requestedAssetCount": 42, # Output only. Number of assets requested for export after resolving the requested filters. "result": { # Contains the result of the assets export. # Output only. Result of the export execution. "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. Error encountered during export. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -261,6 +289,21 @@

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. }, + "outputFiles": { # Contains a list of output files. # Output only. List of output files. + "entries": [ # List of output files. + { # Contains a single output file. + "csvOutputFile": { # Contains a single output file of type CSV. # Output only. CSV output file. + "columnsCount": 42, # Output only. Number of columns in the file. + "rowCount": 42, # Output only. Number of rows in the file. + "signedUri": { # Contains a signed URI. # Output only. Signed URI destination. + "file": "A String", # Output only. Name of the file the Signed URI references. + "uri": "A String", # Output only. Download URI for the file. + }, + }, + "fileSizeBytes": 42, # Output only. File size in bytes. + }, + ], + }, "signedUris": { # Contains a list of Signed URIs. # Output only. Signed URLs for downloading export artifacts. "signedUris": [ # Output only. List of signed URIs. { # Contains a signed URI. @@ -273,6 +316,7 @@

Method Details

"startTime": "A String", # Output only. Execution timestamp. }, ], + "showHidden": True or False, # Optional. When this value is set to 'true' the response will include all assets, including those that are hidden. "signedUriDestination": { # Signed URI destination configuration. # Export to Cloud Storage files downloadable using signed URIs. }, "updateTime": "A String", # Output only. Resource update time. @@ -302,6 +346,8 @@

Method Details

"filter": "A String", # Optional. Assets filter, supports the same syntax as asset listing. }, "createTime": "A String", # Output only. Resource creation time. + "inventory": { # Configuration for asset inventory details exports. # Export asset inventory details. + }, "labels": { # Optional. Labels as key value pairs. Labels must meet the following constraints: * 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. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, @@ -309,11 +355,15 @@

Method Details

"networkDependencies": { # Configuration for network dependencies exports. # Export data regarding asset network dependencies. "maxDays": 42, # Optional. When this value is set to a positive integer, network connections data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. }, + "performanceData": { # Configuration for performance data exports. # Export asset with performance data. + "maxDays": 42, # Optional. When this value is set to a positive integer, performance data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. The maximum value is 420; values above 420 will be coerced to 420. If unset (0 value) a default value of 40 will be used. + }, "recentExecutions": [ # Output only. Recent non expired executions of the job. { # Execution status of assets export job. "endTime": "A String", # Output only. Completion time of the export. "executionId": "A String", # Output only. Globally unique identifier of the execution. "expireTime": "A String", # Output only. Expiration time for the export and artifacts. + "requestedAssetCount": 42, # Output only. Number of assets requested for export after resolving the requested filters. "result": { # Contains the result of the assets export. # Output only. Result of the export execution. "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. Error encountered during export. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -324,6 +374,21 @@

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. }, + "outputFiles": { # Contains a list of output files. # Output only. List of output files. + "entries": [ # List of output files. + { # Contains a single output file. + "csvOutputFile": { # Contains a single output file of type CSV. # Output only. CSV output file. + "columnsCount": 42, # Output only. Number of columns in the file. + "rowCount": 42, # Output only. Number of rows in the file. + "signedUri": { # Contains a signed URI. # Output only. Signed URI destination. + "file": "A String", # Output only. Name of the file the Signed URI references. + "uri": "A String", # Output only. Download URI for the file. + }, + }, + "fileSizeBytes": 42, # Output only. File size in bytes. + }, + ], + }, "signedUris": { # Contains a list of Signed URIs. # Output only. Signed URLs for downloading export artifacts. "signedUris": [ # Output only. List of signed URIs. { # Contains a signed URI. @@ -336,6 +401,7 @@

Method Details

"startTime": "A String", # Output only. Execution timestamp. }, ], + "showHidden": True or False, # Optional. When this value is set to 'true' the response will include all assets, including those that are hidden. "signedUriDestination": { # Signed URI destination configuration. # Export to Cloud Storage files downloadable using signed URIs. }, "updateTime": "A String", # Output only. Resource update time. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html index 90595065192..f7b49f12194 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html @@ -116,7 +116,7 @@

Method Details

"mssqlToCloudSqlForSqlServerPreferences": { # Preferences for SQL Server on Cloud SQL. # Optional. Preferences for target SQL Server on Cloud SQL when migrating from source Microsoft SQL server. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -130,7 +130,7 @@

Method Details

"mysqlToCloudSqlForMysqlPreferences": { # Preferences for MySQL on Cloud SQL. # Optional. Preferences for target MySQL on Cloud SQL when migrating from source MySQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -142,7 +142,7 @@

Method Details

"postgresqlToCloudSqlForPostgresqlPreferences": { # Preferences for PostgreSQL on Cloud SQL. # Optional. Preferences for target PostgreSQL on Cloud SQL when migrating from source PostgreSQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -344,7 +344,7 @@

Method Details

"mssqlToCloudSqlForSqlServerPreferences": { # Preferences for SQL Server on Cloud SQL. # Optional. Preferences for target SQL Server on Cloud SQL when migrating from source Microsoft SQL server. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -358,7 +358,7 @@

Method Details

"mysqlToCloudSqlForMysqlPreferences": { # Preferences for MySQL on Cloud SQL. # Optional. Preferences for target MySQL on Cloud SQL when migrating from source MySQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -370,7 +370,7 @@

Method Details

"postgresqlToCloudSqlForPostgresqlPreferences": { # Preferences for PostgreSQL on Cloud SQL. # Optional. Preferences for target PostgreSQL on Cloud SQL when migrating from source PostgreSQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -512,7 +512,7 @@

Method Details

"mssqlToCloudSqlForSqlServerPreferences": { # Preferences for SQL Server on Cloud SQL. # Optional. Preferences for target SQL Server on Cloud SQL when migrating from source Microsoft SQL server. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -526,7 +526,7 @@

Method Details

"mysqlToCloudSqlForMysqlPreferences": { # Preferences for MySQL on Cloud SQL. # Optional. Preferences for target MySQL on Cloud SQL when migrating from source MySQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -538,7 +538,7 @@

Method Details

"postgresqlToCloudSqlForPostgresqlPreferences": { # Preferences for PostgreSQL on Cloud SQL. # Optional. Preferences for target PostgreSQL on Cloud SQL when migrating from source PostgreSQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -688,7 +688,7 @@

Method Details

"mssqlToCloudSqlForSqlServerPreferences": { # Preferences for SQL Server on Cloud SQL. # Optional. Preferences for target SQL Server on Cloud SQL when migrating from source Microsoft SQL server. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -702,7 +702,7 @@

Method Details

"mysqlToCloudSqlForMysqlPreferences": { # Preferences for MySQL on Cloud SQL. # Optional. Preferences for target MySQL on Cloud SQL when migrating from source MySQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -714,7 +714,7 @@

Method Details

"postgresqlToCloudSqlForPostgresqlPreferences": { # Preferences for PostgreSQL on Cloud SQL. # Optional. Preferences for target PostgreSQL on Cloud SQL when migrating from source PostgreSQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html index 2cc2a792602..30ca6161fb1 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html @@ -540,7 +540,7 @@

Method Details

"mssqlToCloudSqlForSqlServerPreferences": { # Preferences for SQL Server on Cloud SQL. # Optional. Preferences for target SQL Server on Cloud SQL when migrating from source Microsoft SQL server. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -554,7 +554,7 @@

Method Details

"mysqlToCloudSqlForMysqlPreferences": { # Preferences for MySQL on Cloud SQL. # Optional. Preferences for target MySQL on Cloud SQL when migrating from source MySQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -566,7 +566,7 @@

Method Details

"postgresqlToCloudSqlForPostgresqlPreferences": { # Preferences for PostgreSQL on Cloud SQL. # Optional. Preferences for target PostgreSQL on Cloud SQL when migrating from source PostgreSQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -1323,7 +1323,7 @@

Method Details

"mssqlToCloudSqlForSqlServerPreferences": { # Preferences for SQL Server on Cloud SQL. # Optional. Preferences for target SQL Server on Cloud SQL when migrating from source Microsoft SQL server. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -1337,7 +1337,7 @@

Method Details

"mysqlToCloudSqlForMysqlPreferences": { # Preferences for MySQL on Cloud SQL. # Optional. Preferences for target MySQL on Cloud SQL when migrating from source MySQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -1349,7 +1349,7 @@

Method Details

"postgresqlToCloudSqlForPostgresqlPreferences": { # Preferences for PostgreSQL on Cloud SQL. # Optional. Preferences for target PostgreSQL on Cloud SQL when migrating from source PostgreSQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -2047,7 +2047,7 @@

Method Details

"mssqlToCloudSqlForSqlServerPreferences": { # Preferences for SQL Server on Cloud SQL. # Optional. Preferences for target SQL Server on Cloud SQL when migrating from source Microsoft SQL server. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -2061,7 +2061,7 @@

Method Details

"mysqlToCloudSqlForMysqlPreferences": { # Preferences for MySQL on Cloud SQL. # Optional. Preferences for target MySQL on Cloud SQL when migrating from source MySQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. @@ -2073,7 +2073,7 @@

Method Details

"postgresqlToCloudSqlForPostgresqlPreferences": { # Preferences for PostgreSQL on Cloud SQL. # Optional. Preferences for target PostgreSQL on Cloud SQL when migrating from source PostgreSQL. "common": { # Preferences common to Cloud SQL databases. # Optional. Preferences to Cloud SQL databases. "backup": { # Preferences for database backups. # Optional. Preferences for database backups. - "backupMode": "A String", # Optional. Mode of automated backups. + "backupMode": "A String", # Optional. Automated backup mode. }, "commitmentPlan": "A String", # Optional. Commitment plan to consider when calculating costs. Only regular CUDs (not flexible) are currently available. "edition": "A String", # Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html index 66cffa064d6..82f8d3104ec 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html @@ -301,8 +301,8 @@

Method Details

}, ], }, - "hosts": { # Hosts content. # Hosts file (/etc/hosts). - "entries": [ # Hosts entries. + "hosts": { # Hosts content. # Output only. Hosts file (/etc/hosts). + "entries": [ # Output only. Hosts entries. { # Single /etc/hosts entry. "hostNames": [ # List of host names / aliases. "A String", @@ -753,8 +753,8 @@

Method Details

}, ], }, - "hosts": { # Hosts content. # Hosts file (/etc/hosts). - "entries": [ # Hosts entries. + "hosts": { # Hosts content. # Output only. Hosts file (/etc/hosts). + "entries": [ # Output only. Hosts entries. { # Single /etc/hosts entry. "hostNames": [ # List of host names / aliases. "A String", diff --git a/docs/dyn/monitoring_v1.projects.dashboards.html b/docs/dyn/monitoring_v1.projects.dashboards.html index 562f57c8af8..a0ffa6149a6 100644 --- a/docs/dyn/monitoring_v1.projects.dashboards.html +++ b/docs/dyn/monitoring_v1.projects.dashboards.html @@ -449,7 +449,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -1149,7 +1160,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -1745,7 +1767,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -2343,7 +2376,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -2966,7 +3010,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -3666,7 +3721,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -4262,7 +4328,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -4860,7 +4937,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -5507,7 +5595,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -6207,7 +6306,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -6803,7 +6913,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -7401,7 +7522,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -8034,7 +8166,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -8734,7 +8877,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -9330,7 +9484,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -9928,7 +10093,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -10569,7 +10745,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -11269,7 +11456,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -11865,7 +12063,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -12463,7 +12672,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -13086,7 +13306,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -13786,7 +14017,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -14382,7 +14624,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], @@ -14980,7 +15233,18 @@

Method Details

"timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. + "alignment": "A String", # Optional. Whether the column should be left / middle / right aligned "column": "A String", # Required. The id of the column. + "displayName": "A String", # Optional. Display name of the column + "thresholds": [ # Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value. + { # Defines a threshold for categorizing time series values. + "color": "A String", # The state color for this threshold. Color is not allowed in a XyChart. + "direction": "A String", # The direction for the current threshold. Direction is not allowed in a XyChart. + "label": "A String", # A label for the threshold. + "targetAxis": "A String", # The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. + "value": 3.14, # The value of the threshold. The value should be defined in the native scale of the metric. + }, + ], "visible": True or False, # Required. Whether the column should be visible on page load. }, ], diff --git a/docs/dyn/monitoring_v3.projects.metricDescriptors.html b/docs/dyn/monitoring_v3.projects.metricDescriptors.html index 1ed43448aeb..d285d878fd4 100644 --- a/docs/dyn/monitoring_v3.projects.metricDescriptors.html +++ b/docs/dyn/monitoring_v3.projects.metricDescriptors.html @@ -122,6 +122,9 @@

Method Details

"ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. + "timeSeriesResourceHierarchyLevel": [ # The scope of the timeseries data of the metric. + "A String", + ], }, "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. @@ -156,6 +159,9 @@

Method Details

"ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. + "timeSeriesResourceHierarchyLevel": [ # The scope of the timeseries data of the metric. + "A String", + ], }, "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. @@ -215,6 +221,9 @@

Method Details

"ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. + "timeSeriesResourceHierarchyLevel": [ # The scope of the timeseries data of the metric. + "A String", + ], }, "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. @@ -261,6 +270,9 @@

Method Details

"ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. + "timeSeriesResourceHierarchyLevel": [ # The scope of the timeseries data of the metric. + "A String", + ], }, "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. diff --git a/docs/dyn/monitoring_v3.projects.timeSeries.html b/docs/dyn/monitoring_v3.projects.timeSeries.html index 69fe62c35aa..b586ed7ece0 100644 --- a/docs/dyn/monitoring_v3.projects.timeSeries.html +++ b/docs/dyn/monitoring_v3.projects.timeSeries.html @@ -91,7 +91,7 @@

Instance Methods

Retrieves the next page of results.

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

-

Queries time series using Monitoring Query Language.

+

Queries time series by using Monitoring Query Language (MQL). We recommend using PromQL instead of MQL. For more information about the status of MQL, see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql).

query_next()

Retrieves the next page of results.

@@ -530,14 +530,14 @@

Method Details

query(name, body=None, x__xgafv=None) -
Queries time series using Monitoring Query Language.
+  
Queries time series by using Monitoring Query Language (MQL). We recommend using PromQL instead of MQL. For more information about the status of MQL, see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql).
 
 Args:
   name: string, Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]  (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # The QueryTimeSeries request.
+{ # The QueryTimeSeries request. For information about the status of Monitoring Query Language (MQL), see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql).
   "pageSize": 42, # A positive number that is the maximum number of time_series_data to return.
   "pageToken": "A String", # If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
   "query": "A String", # Required. The query in the Monitoring Query Language (https://cloud.google.com/monitoring/mql/reference) format. The default time zone is in UTC.
@@ -551,7 +551,7 @@ 

Method Details

Returns: An object of the form: - { # The QueryTimeSeries response. + { # The QueryTimeSeries response. For information about the status of Monitoring Query Language (MQL), see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql). "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. "partialErrors": [ # Query execution errors that may have caused the time series data returned to be incomplete. The available data will be available in the response. { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.html b/docs/dyn/networksecurity_v1beta1.projects.locations.html index 65105b53073..2e4684540f9 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.html @@ -104,6 +104,26 @@

Instance Methods

Returns the gatewaySecurityPolicies Resource.

+

+ mirroringDeploymentGroups() +

+

Returns the mirroringDeploymentGroups Resource.

+ +

+ mirroringDeployments() +

+

Returns the mirroringDeployments Resource.

+ +

+ mirroringEndpointGroupAssociations() +

+

Returns the mirroringEndpointGroupAssociations Resource.

+ +

+ mirroringEndpointGroups() +

+

Returns the mirroringEndpointGroups Resource.

+

operations()

diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringDeploymentGroups.html b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringDeploymentGroups.html new file mode 100644 index 00000000000..072c8e67a13 --- /dev/null +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringDeploymentGroups.html @@ -0,0 +1,341 @@ + + + +

Network Security API . projects . locations . mirroringDeploymentGroups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new MirroringDeploymentGroup in a given project and location.

+

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

+

Deletes a single MirroringDeploymentGroup.

+

+ get(name, x__xgafv=None)

+

Gets details of a single MirroringDeploymentGroup.

+

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

+

Lists MirroringDeploymentGroups 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 a single MirroringDeploymentGroup.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, mirroringDeploymentGroupId=None, requestId=None, x__xgafv=None) +
Creates a new MirroringDeploymentGroup in a given project and location.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing MirroringDeploymentGroup object
+  "connectedEndpointGroups": [ # Output only. The list of Mirroring Endpoint Groups that are connected to this resource.
+    { # An endpoint group connected to this deployment group.
+      "name": "A String", # Output only. A connected mirroring endpoint group.
+    },
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Immutable. Identifier. Then name of the MirroringDeploymentGroup.
+  "network": "A String", # Required. Immutable. The network that is being used for the deployment. Format is: projects/{project}/global/networks/{network}.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the deployment group.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+  mirroringDeploymentGroupId: string, Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_group_id from the method_signature of Create RPC
+  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).
+  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 MirroringDeploymentGroup.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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 MirroringDeploymentGroup.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing MirroringDeploymentGroup object
+  "connectedEndpointGroups": [ # Output only. The list of Mirroring Endpoint Groups that are connected to this resource.
+    { # An endpoint group connected to this deployment group.
+      "name": "A String", # Output only. A connected mirroring endpoint group.
+    },
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Immutable. Identifier. Then name of the MirroringDeploymentGroup.
+  "network": "A String", # Required. Immutable. The network that is being used for the deployment. Format is: projects/{project}/global/networks/{network}.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the deployment group.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists MirroringDeploymentGroups in a given project and location.
+
+Args:
+  parent: string, Required. Parent value for ListMirroringDeploymentGroupsRequest (required)
+  filter: string, Optional. Filtering results
+  orderBy: string, Optional. Hint for how to order the results
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  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 MirroringDeploymentGroups
+  "mirroringDeploymentGroups": [ # The list of MirroringDeploymentGroup
+    { # Message describing MirroringDeploymentGroup object
+      "connectedEndpointGroups": [ # Output only. The list of Mirroring Endpoint Groups that are connected to this resource.
+        { # An endpoint group connected to this deployment group.
+          "name": "A String", # Output only. A connected mirroring endpoint group.
+        },
+      ],
+      "createTime": "A String", # Output only. [Output only] Create time stamp
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "name": "A String", # Immutable. Identifier. Then name of the MirroringDeploymentGroup.
+      "network": "A String", # Required. Immutable. The network that is being used for the deployment. Format is: projects/{project}/global/networks/{network}.
+      "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+      "state": "A String", # Output only. Current state of the deployment group.
+      "updateTime": "A String", # Output only. [Output only] Update time stamp
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+}
+
+ +
+ 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 a single MirroringDeploymentGroup.
+
+Args:
+  name: string, Immutable. Identifier. Then name of the MirroringDeploymentGroup. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing MirroringDeploymentGroup object
+  "connectedEndpointGroups": [ # Output only. The list of Mirroring Endpoint Groups that are connected to this resource.
+    { # An endpoint group connected to this deployment group.
+      "name": "A String", # Output only. A connected mirroring endpoint group.
+    },
+  ],
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Immutable. Identifier. Then name of the MirroringDeploymentGroup.
+  "network": "A String", # Required. Immutable. The network that is being used for the deployment. Format is: projects/{project}/global/networks/{network}.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the deployment group.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+  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 MirroringDeploymentGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  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.mirroringDeployments.html b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringDeployments.html new file mode 100644 index 00000000000..be483bc1811 --- /dev/null +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringDeployments.html @@ -0,0 +1,328 @@ + + + +

Network Security API . projects . locations . mirroringDeployments

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new MirroringDeployment in a given project and location.

+

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

+

Deletes a single MirroringDeployment.

+

+ get(name, x__xgafv=None)

+

Gets details of a single MirroringDeployment.

+

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

+

Lists MirroringDeployments 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 a single MirroringDeployment.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, mirroringDeploymentId=None, requestId=None, x__xgafv=None) +
Creates a new MirroringDeployment in a given project and location.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing MirroringDeployment object
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "forwardingRule": "A String", # Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "mirroringDeploymentGroup": "A String", # Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`
+  "name": "A String", # Immutable. Identifier. The name of the MirroringDeployment.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the deployment.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+  mirroringDeploymentId: string, Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC
+  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).
+  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 MirroringDeployment.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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 MirroringDeployment.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing MirroringDeployment object
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "forwardingRule": "A String", # Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "mirroringDeploymentGroup": "A String", # Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`
+  "name": "A String", # Immutable. Identifier. The name of the MirroringDeployment.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the deployment.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists MirroringDeployments in a given project and location.
+
+Args:
+  parent: string, Required. Parent value for ListMirroringDeploymentsRequest (required)
+  filter: string, Optional. Filtering results
+  orderBy: string, Optional. Hint for how to order the results
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  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 MirroringDeployments
+  "mirroringDeployments": [ # The list of MirroringDeployment
+    { # Message describing MirroringDeployment object
+      "createTime": "A String", # Output only. [Output only] Create time stamp
+      "forwardingRule": "A String", # Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "mirroringDeploymentGroup": "A String", # Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`
+      "name": "A String", # Immutable. Identifier. The name of the MirroringDeployment.
+      "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+      "state": "A String", # Output only. Current state of the deployment.
+      "updateTime": "A String", # Output only. [Output only] Update time stamp
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "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 a single MirroringDeployment.
+
+Args:
+  name: string, Immutable. Identifier. The name of the MirroringDeployment. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing MirroringDeployment object
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "forwardingRule": "A String", # Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "mirroringDeploymentGroup": "A String", # Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`
+  "name": "A String", # Immutable. Identifier. The name of the MirroringDeployment.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the deployment.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+  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 MirroringDeployment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  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.mirroringEndpointGroupAssociations.html b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringEndpointGroupAssociations.html new file mode 100644 index 00000000000..c158a4204b7 --- /dev/null +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringEndpointGroupAssociations.html @@ -0,0 +1,349 @@ + + + +

Network Security API . projects . locations . mirroringEndpointGroupAssociations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new MirroringEndpointGroupAssociation in a given project and location.

+

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

+

Deletes a single MirroringEndpointGroupAssociation.

+

+ get(name, x__xgafv=None)

+

Gets details of a single MirroringEndpointGroupAssociation.

+

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

+

Lists MirroringEndpointGroupAssociations 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 a single MirroringEndpointGroupAssociation.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, mirroringEndpointGroupAssociationId=None, requestId=None, x__xgafv=None) +
Creates a new MirroringEndpointGroupAssociation in a given project and location.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing MirroringEndpointGroupAssociation object
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "locationsDetails": [ # Output only. The list of locations that this association is in and its details.
+    { # Details about the association status in a specific cloud location.
+      "location": "A String", # Output only. The cloud location.
+      "state": "A String", # Output only. The association state in this location.
+    },
+  ],
+  "mirroringEndpointGroup": "A String", # Required. Immutable. The Mirroring Endpoint Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringEndpointGroups/{mirroringEndpointGroup}`
+  "name": "A String", # Immutable. Identifier. The name of the MirroringEndpointGroupAssociation.
+  "network": "A String", # Required. Immutable. The VPC network associated. Format: projects/{project}/global/networks/{network}.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the endpoint group association.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+  mirroringEndpointGroupAssociationId: string, Optional. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_association_id from the method_signature of Create RPC
+  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).
+  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 MirroringEndpointGroupAssociation.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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 MirroringEndpointGroupAssociation.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing MirroringEndpointGroupAssociation object
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "locationsDetails": [ # Output only. The list of locations that this association is in and its details.
+    { # Details about the association status in a specific cloud location.
+      "location": "A String", # Output only. The cloud location.
+      "state": "A String", # Output only. The association state in this location.
+    },
+  ],
+  "mirroringEndpointGroup": "A String", # Required. Immutable. The Mirroring Endpoint Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringEndpointGroups/{mirroringEndpointGroup}`
+  "name": "A String", # Immutable. Identifier. The name of the MirroringEndpointGroupAssociation.
+  "network": "A String", # Required. Immutable. The VPC network associated. Format: projects/{project}/global/networks/{network}.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the endpoint group association.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists MirroringEndpointGroupAssociations in a given project and location.
+
+Args:
+  parent: string, Required. Parent value for ListMirroringEndpointGroupAssociationsRequest (required)
+  filter: string, Optional. Filtering results
+  orderBy: string, Optional. Hint for how to order the results
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  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 MirroringEndpointGroupAssociations
+  "mirroringEndpointGroupAssociations": [ # The list of MirroringEndpointGroupAssociation
+    { # Message describing MirroringEndpointGroupAssociation object
+      "createTime": "A String", # Output only. [Output only] Create time stamp
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "locationsDetails": [ # Output only. The list of locations that this association is in and its details.
+        { # Details about the association status in a specific cloud location.
+          "location": "A String", # Output only. The cloud location.
+          "state": "A String", # Output only. The association state in this location.
+        },
+      ],
+      "mirroringEndpointGroup": "A String", # Required. Immutable. The Mirroring Endpoint Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringEndpointGroups/{mirroringEndpointGroup}`
+      "name": "A String", # Immutable. Identifier. The name of the MirroringEndpointGroupAssociation.
+      "network": "A String", # Required. Immutable. The VPC network associated. Format: projects/{project}/global/networks/{network}.
+      "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+      "state": "A String", # Output only. Current state of the endpoint group association.
+      "updateTime": "A String", # Output only. [Output only] Update time stamp
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+}
+
+ +
+ 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 a single MirroringEndpointGroupAssociation.
+
+Args:
+  name: string, Immutable. Identifier. The name of the MirroringEndpointGroupAssociation. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing MirroringEndpointGroupAssociation object
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "locationsDetails": [ # Output only. The list of locations that this association is in and its details.
+    { # Details about the association status in a specific cloud location.
+      "location": "A String", # Output only. The cloud location.
+      "state": "A String", # Output only. The association state in this location.
+    },
+  ],
+  "mirroringEndpointGroup": "A String", # Required. Immutable. The Mirroring Endpoint Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringEndpointGroups/{mirroringEndpointGroup}`
+  "name": "A String", # Immutable. Identifier. The name of the MirroringEndpointGroupAssociation.
+  "network": "A String", # Required. Immutable. The VPC network associated. Format: projects/{project}/global/networks/{network}.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the endpoint group association.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+  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 MirroringEndpointGroupAssociation resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  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.mirroringEndpointGroups.html b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringEndpointGroups.html new file mode 100644 index 00000000000..b0a0206f0ff --- /dev/null +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringEndpointGroups.html @@ -0,0 +1,321 @@ + + + +

Network Security API . projects . locations . mirroringEndpointGroups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new MirroringEndpointGroup in a given project and location.

+

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

+

Deletes a single MirroringEndpointGroup.

+

+ get(name, x__xgafv=None)

+

Gets details of a single MirroringEndpointGroup.

+

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

+

Lists MirroringEndpointGroups 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 a single MirroringEndpointGroup.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, mirroringEndpointGroupId=None, requestId=None, x__xgafv=None) +
Creates a new MirroringEndpointGroup in a given project and location.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing MirroringEndpointGroup object
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "mirroringDeploymentGroup": "A String", # Required. Immutable. The Mirroring Deployment Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`
+  "name": "A String", # Immutable. Identifier. The name of the MirroringEndpointGroup.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the endpoint group.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+  mirroringEndpointGroupId: string, Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_id from the method_signature of Create RPC
+  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).
+  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 MirroringEndpointGroup.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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 MirroringEndpointGroup.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing MirroringEndpointGroup object
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "mirroringDeploymentGroup": "A String", # Required. Immutable. The Mirroring Deployment Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`
+  "name": "A String", # Immutable. Identifier. The name of the MirroringEndpointGroup.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the endpoint group.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists MirroringEndpointGroups in a given project and location.
+
+Args:
+  parent: string, Required. Parent value for ListMirroringEndpointGroupsRequest (required)
+  filter: string, Optional. Filtering results
+  orderBy: string, Optional. Hint for how to order the results
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  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 MirroringEndpointGroups
+  "mirroringEndpointGroups": [ # The list of MirroringEndpointGroup
+    { # Message describing MirroringEndpointGroup object
+      "createTime": "A String", # Output only. [Output only] Create time stamp
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "mirroringDeploymentGroup": "A String", # Required. Immutable. The Mirroring Deployment Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`
+      "name": "A String", # Immutable. Identifier. The name of the MirroringEndpointGroup.
+      "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+      "state": "A String", # Output only. Current state of the endpoint group.
+      "updateTime": "A String", # Output only. [Output only] Update time stamp
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+}
+
+ +
+ 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 a single MirroringEndpointGroup.
+
+Args:
+  name: string, Immutable. Identifier. The name of the MirroringEndpointGroup. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing MirroringEndpointGroup object
+  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "mirroringDeploymentGroup": "A String", # Required. Immutable. The Mirroring Deployment Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`
+  "name": "A String", # Immutable. Identifier. The name of the MirroringEndpointGroup.
+  "reconciling": True or False, # Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
+  "state": "A String", # Output only. Current state of the endpoint group.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp
+}
+
+  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 MirroringEndpointGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  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/osconfig_v1.projects.locations.osPolicyAssignments.html b/docs/dyn/osconfig_v1.projects.locations.osPolicyAssignments.html index fe6e9ea6dfd..ad0ac97c9ec 100644 --- a/docs/dyn/osconfig_v1.projects.locations.osPolicyAssignments.html +++ b/docs/dyn/osconfig_v1.projects.locations.osPolicyAssignments.html @@ -185,7 +185,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. - "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes. + "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes. "script": "A String", # An inline script. The size of the script is limited to 32KiB. }, "validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate. @@ -206,7 +206,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. - "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes. + "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes. "script": "A String", # An inline script. The size of the script is limited to 32KiB. }, }, @@ -491,7 +491,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. - "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes. + "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes. "script": "A String", # An inline script. The size of the script is limited to 32KiB. }, "validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate. @@ -512,7 +512,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. - "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes. + "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes. "script": "A String", # An inline script. The size of the script is limited to 32KiB. }, }, @@ -736,7 +736,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. - "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes. + "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes. "script": "A String", # An inline script. The size of the script is limited to 32KiB. }, "validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate. @@ -757,7 +757,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. - "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes. + "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes. "script": "A String", # An inline script. The size of the script is limited to 32KiB. }, }, @@ -983,7 +983,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. - "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes. + "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes. "script": "A String", # An inline script. The size of the script is limited to 32KiB. }, "validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate. @@ -1004,7 +1004,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. - "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes. + "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes. "script": "A String", # An inline script. The size of the script is limited to 32KiB. }, }, @@ -1248,7 +1248,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. - "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes. + "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes. "script": "A String", # An inline script. The size of the script is limited to 32KiB. }, "validate": { # A file or script to execute. # Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate. @@ -1269,7 +1269,7 @@

Method Details

}, }, "interpreter": "A String", # Required. The script interpreter to use. - "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes. + "outputFilePath": "A String", # Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes. "script": "A String", # An inline script. The size of the script is limited to 32KiB. }, }, diff --git a/docs/dyn/run_v2.projects.locations.builds.html b/docs/dyn/run_v2.projects.locations.builds.html index 75d6033331d..b0b7201945a 100644 --- a/docs/dyn/run_v2.projects.locations.builds.html +++ b/docs/dyn/run_v2.projects.locations.builds.html @@ -131,6 +131,7 @@

Method Details

{ # Response message for submitting a Build. "baseImageUri": "A String", # URI of the base builder image in Artifact Registry being used in the build. Used to opt into automatic base image updates. + "baseImageWarning": "A String", # Warning message for the base image. "buildOperation": { # This resource represents a long-running operation that is the result of a network API call. # Cloud Build operation to be polled via CloudBuild API. "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index 48e8a9e7855..b18f30b7f25 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -282,7 +282,7 @@

Method Details

}, "revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name. "scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision. - "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. + "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, "serviceAccount": "A String", # Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. @@ -614,7 +614,7 @@

Method Details

}, "revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name. "scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision. - "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. + "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, "serviceAccount": "A String", # Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. @@ -933,7 +933,7 @@

Method Details

}, "revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name. "scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision. - "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. + "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, "serviceAccount": "A String", # Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. @@ -1209,7 +1209,7 @@

Method Details

}, "revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name. "scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision. - "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. + "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, "serviceAccount": "A String", # Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html index 9ce9be54117..ded4bc6fd72 100644 --- a/docs/dyn/run_v2.projects.locations.services.revisions.html +++ b/docs/dyn/run_v2.projects.locations.services.revisions.html @@ -317,7 +317,7 @@

Method Details

"reconciling": True or False, # Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Service.reconciling` for additional information on reconciliation process in Cloud Run. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scaling": { # Settings for revision-level scaling settings. # Scaling settings for this revision. - "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. + "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, "scalingStatus": { # Effective settings for the current revision # Output only. The current effective scaling settings for the revision. @@ -534,7 +534,7 @@

Method Details

"reconciling": True or False, # Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Service.reconciling` for additional information on reconciliation process in Cloud Run. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scaling": { # Settings for revision-level scaling settings. # Scaling settings for this revision. - "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. + "maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances "minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have. }, "scalingStatus": { # Effective settings for the current revision # Output only. The current effective scaling settings for the revision. diff --git a/docs/dyn/servicenetworking_v1.services.roles.html b/docs/dyn/servicenetworking_v1.services.roles.html index 5710bf207a0..e4e608ae73e 100644 --- a/docs/dyn/servicenetworking_v1.services.roles.html +++ b/docs/dyn/servicenetworking_v1.services.roles.html @@ -95,7 +95,7 @@

Method Details

"policyBinding": [ # Required. List of policy bindings to add to shared VPC host project. { # Grouping of IAM role and IAM member. "member": "A String", # Required. Member to bind the role with. See /iam/docs/reference/rest/v1/Policy#Binding for how to format each member. Eg. - user:myuser@mydomain.com - serviceAccount:my-service-account@app.gserviceaccount.com - "role": "A String", # Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project - 'roles/monitoring.viewer' applied on the shared VPC host project + "role": "A String", # Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project - 'roles/monitoring.viewer' applied on the shared VPC host project - 'roles/servicemanagement.quotaViewer' applied on the shared VPC host project }, ], } diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index d1a96a70223..9426bb71dfb 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -74,12 +74,21 @@

Cloud SQL Admin API . instances

Instance Methods

+

+ ListServerCertificates(project, instance, x__xgafv=None)

+

Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.

+

+ RotateServerCertificate(project, instance, body=None, x__xgafv=None)

+

Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, please use RotateServerCa instead.

acquireSsrsLease(project, instance, body=None, x__xgafv=None)

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.

+

+ addServerCertificate(project, instance, x__xgafv=None)

+

Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, please use AddServerCa instead.

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.

@@ -159,6 +168,197 @@

Instance Methods

update(project, instance, body=None, x__xgafv=None)

Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.

Method Details

+
+ ListServerCertificates(project, instance, x__xgafv=None) +
Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.
+
+Args:
+  project: string, Required. Project ID of the project that contains the instance. (required)
+  instance: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Instances ListServerCertificates response.
+  "activeVersion": "A String", # The `sha1_fingerprint` of the active certificate from `server_certs`.
+  "caCerts": [ # List of server CA certificates for the instance.
+    { # SslCerts Resource
+      "cert": "A String", # PEM representation.
+      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+      "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`
+      "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+      "instance": "A String", # Name of the database instance.
+      "kind": "A String", # This is always `sql#sslCert`.
+      "selfLink": "A String", # The URI of this resource.
+      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+    },
+  ],
+  "kind": "A String", # This is always `sql#instancesListServerCertificates`.
+  "serverCerts": [ # List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list.
+    { # SslCerts Resource
+      "cert": "A String", # PEM representation.
+      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+      "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`
+      "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+      "instance": "A String", # Name of the database instance.
+      "kind": "A String", # This is always `sql#sslCert`.
+      "selfLink": "A String", # The URI of this resource.
+      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+    },
+  ],
+}
+
+ +
+ RotateServerCertificate(project, instance, body=None, x__xgafv=None) +
Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, please use RotateServerCa instead.
+
+Args:
+  project: string, Required. Project ID of the project that contains the instance. (required)
+  instance: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Rotate server certificate request.
+  "rotateServerCertificateContext": { # Instance rotate server certificate context. # Optional. Contains details about the rotate server certificate operation.
+    "kind": "A String", # Optional. This is always `sql#rotateServerCertificateContext`.
+    "nextVersion": "A String", # The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
+  "acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
+    "duration": "A String", # Lease duration needed for SSRS setup.
+    "reportDatabase": "A String", # The report database to be used for SSRS setup.
+    "serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
+    "setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
+  },
+  "apiWarning": { # An Admin API warning message. # An Admin API warning message.
+    "code": "A String", # Code to uniquely identify the warning type.
+    "message": "A String", # The warning message.
+    "region": "A String", # The region name for REGION_UNREACHABLE warning.
+  },
+  "backupContext": { # Backup context. # The context for backup operation, if applicable.
+    "backupId": "A String", # The identifier of the backup.
+    "kind": "A String", # This is always `sql#backupContext`.
+  },
+  "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+    "errors": [ # The list of errors encountered while processing this operation.
+      { # Database instance operation error.
+        "code": "A String", # Identifies the specific error that occurred.
+        "kind": "A String", # This is always `sql#operationError`.
+        "message": "A String", # Additional information about the error encountered.
+      },
+    ],
+    "kind": "A String", # This is always `sql#operationErrors`.
+  },
+  "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+    "bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
+      "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
+      "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
+      "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
+      "exportLogEndTime": "A String", # Optional. The end timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs until current time will be included. Only applied to Cloud SQL for SQL Server.
+      "exportLogStartTime": "A String", # Optional. The begin timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs from the beginning of retention period will be included. Only applied to Cloud SQL for SQL Server.
+      "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
+      "striped": True or False, # Whether or not the export should be striped.
+    },
+    "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "selectQuery": "A String", # The select query used to extract the data.
+    },
+    "databases": [ # Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
+      "A String",
+    ],
+    "fileType": "A String", # The file type for the specified uri.
+    "kind": "A String", # This is always `sql#exportContext`.
+    "offload": True or False, # Option for export offload.
+    "sqlExportOptions": { # Options for exporting data as SQL statements.
+      "mysqlExportOptions": { # Options for exporting from MySQL.
+        "masterData": 42, # Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.
+      },
+      "parallel": True or False, # Optional. Whether or not the export should be parallel.
+      "postgresExportOptions": { # Options for exporting from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. Use this option to include DROP SQL statements. These statements are used to delete database objects before running the import operation.
+        "ifExists": True or False, # Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.
+      },
+      "schemaOnly": True or False, # Export only schemas.
+      "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
+        "A String",
+      ],
+      "threads": 42, # Optional. The number of threads to use for parallel export.
+    },
+    "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
+  },
+  "importContext": { # Database instance import context. # The context for import operation, if applicable.
+    "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+      "bakType": "A String", # Type of the bak content, FULL or DIFF
+      "encryptionOptions": {
+        "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+        "pvkPassword": "A String", # Password that encrypts the private key
+        "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+      },
+      "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
+      "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
+      "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
+      "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
+      "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
+    },
+    "csvImportOptions": { # Options for importing data as CSV.
+      "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
+        "A String",
+      ],
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "table": "A String", # The table to which CSV data is imported.
+    },
+    "database": "A String", # The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified.
+    "fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
+    "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+    "kind": "A String", # This is always `sql#importContext`.
+    "sqlImportOptions": { # Optional. Options for importing data from SQL statements.
+      "parallel": True or False, # Optional. Whether or not the import should be parallel.
+      "postgresImportOptions": { # Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+        "ifExists": True or False, # Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+      },
+      "threads": 42, # Optional. The number of threads to use for parallel import.
+    },
+    "uri": "A String", # Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
+  },
+  "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "kind": "A String", # This is always `sql#operation`.
+  "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
+  "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "selfLink": "A String", # The URI of this resource.
+  "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "status": "A String", # The status of an operation.
+  "targetId": "A String", # Name of the database instance related to this operation.
+  "targetLink": "A String",
+  "targetProject": "A String", # The project ID of the target instance related to this operation.
+  "user": "A String", # The email address of the user who initiated this operation.
+}
+
+
acquireSsrsLease(project, instance, body=None, x__xgafv=None)
Acquire a lease for the setup of SQL Server Reporting Services (SSRS).
@@ -325,6 +525,140 @@ 

Method Details

}
+
+ addServerCertificate(project, instance, x__xgafv=None) +
Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, please use AddServerCa instead.
+
+Args:
+  project: string, Project ID of the project that contains the instance. (required)
+  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
+  "acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
+    "duration": "A String", # Lease duration needed for SSRS setup.
+    "reportDatabase": "A String", # The report database to be used for SSRS setup.
+    "serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
+    "setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
+  },
+  "apiWarning": { # An Admin API warning message. # An Admin API warning message.
+    "code": "A String", # Code to uniquely identify the warning type.
+    "message": "A String", # The warning message.
+    "region": "A String", # The region name for REGION_UNREACHABLE warning.
+  },
+  "backupContext": { # Backup context. # The context for backup operation, if applicable.
+    "backupId": "A String", # The identifier of the backup.
+    "kind": "A String", # This is always `sql#backupContext`.
+  },
+  "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+    "errors": [ # The list of errors encountered while processing this operation.
+      { # Database instance operation error.
+        "code": "A String", # Identifies the specific error that occurred.
+        "kind": "A String", # This is always `sql#operationError`.
+        "message": "A String", # Additional information about the error encountered.
+      },
+    ],
+    "kind": "A String", # This is always `sql#operationErrors`.
+  },
+  "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+    "bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
+      "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
+      "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
+      "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
+      "exportLogEndTime": "A String", # Optional. The end timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs until current time will be included. Only applied to Cloud SQL for SQL Server.
+      "exportLogStartTime": "A String", # Optional. The begin timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs from the beginning of retention period will be included. Only applied to Cloud SQL for SQL Server.
+      "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
+      "striped": True or False, # Whether or not the export should be striped.
+    },
+    "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "selectQuery": "A String", # The select query used to extract the data.
+    },
+    "databases": [ # Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
+      "A String",
+    ],
+    "fileType": "A String", # The file type for the specified uri.
+    "kind": "A String", # This is always `sql#exportContext`.
+    "offload": True or False, # Option for export offload.
+    "sqlExportOptions": { # Options for exporting data as SQL statements.
+      "mysqlExportOptions": { # Options for exporting from MySQL.
+        "masterData": 42, # Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.
+      },
+      "parallel": True or False, # Optional. Whether or not the export should be parallel.
+      "postgresExportOptions": { # Options for exporting from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. Use this option to include DROP SQL statements. These statements are used to delete database objects before running the import operation.
+        "ifExists": True or False, # Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.
+      },
+      "schemaOnly": True or False, # Export only schemas.
+      "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
+        "A String",
+      ],
+      "threads": 42, # Optional. The number of threads to use for parallel export.
+    },
+    "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
+  },
+  "importContext": { # Database instance import context. # The context for import operation, if applicable.
+    "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+      "bakType": "A String", # Type of the bak content, FULL or DIFF
+      "encryptionOptions": {
+        "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+        "pvkPassword": "A String", # Password that encrypts the private key
+        "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+      },
+      "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
+      "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
+      "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
+      "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
+      "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
+    },
+    "csvImportOptions": { # Options for importing data as CSV.
+      "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
+        "A String",
+      ],
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "table": "A String", # The table to which CSV data is imported.
+    },
+    "database": "A String", # The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified.
+    "fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
+    "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+    "kind": "A String", # This is always `sql#importContext`.
+    "sqlImportOptions": { # Optional. Options for importing data from SQL statements.
+      "parallel": True or False, # Optional. Whether or not the import should be parallel.
+      "postgresImportOptions": { # Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+        "ifExists": True or False, # Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+      },
+      "threads": 42, # Optional. The number of threads to use for parallel import.
+    },
+    "uri": "A String", # Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
+  },
+  "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "kind": "A String", # This is always `sql#operation`.
+  "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
+  "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "selfLink": "A String", # The URI of this resource.
+  "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "status": "A String", # The status of an operation.
+  "targetId": "A String", # Name of the database instance related to this operation.
+  "targetLink": "A String",
+  "targetProject": "A String", # The project ID of the target instance related to this operation.
+  "user": "A String", # The email address of the user who initiated this operation.
+}
+
+
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.
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html
index 1a4e60e2667..65c715b0002 100644
--- a/docs/dyn/sqladmin_v1beta4.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.instances.html
@@ -74,12 +74,21 @@
 
 

Cloud SQL Admin API . instances

Instance Methods

+

+ ListServerCertificates(project, instance, x__xgafv=None)

+

Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.

+

+ RotateServerCertificate(project, instance, body=None, x__xgafv=None)

+

Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, please use RotateServerCa instead.

acquireSsrsLease(project, instance, body=None, x__xgafv=None)

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.

+

+ addServerCertificate(project, instance, x__xgafv=None)

+

Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, please use AddServerCa instead.

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.

@@ -159,6 +168,197 @@

Instance Methods

update(project, instance, body=None, x__xgafv=None)

Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.

Method Details

+
+ ListServerCertificates(project, instance, x__xgafv=None) +
Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.
+
+Args:
+  project: string, Required. Project ID of the project that contains the instance. (required)
+  instance: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Instances ListServerCertificatess response.
+  "activeVersion": "A String", # The `sha1_fingerprint` of the active certificate from `server_certs`.
+  "caCerts": [ # List of server CA certificates for the instance.
+    { # SslCerts Resource
+      "cert": "A String", # PEM representation.
+      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+      "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+      "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+      "instance": "A String", # Name of the database instance.
+      "kind": "A String", # This is always `sql#sslCert`.
+      "selfLink": "A String", # The URI of this resource.
+      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+    },
+  ],
+  "kind": "A String", # This is always `sql#instancesListServerCertificates`.
+  "serverCerts": [ # List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list.
+    { # SslCerts Resource
+      "cert": "A String", # PEM representation.
+      "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+      "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+      "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+      "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+      "instance": "A String", # Name of the database instance.
+      "kind": "A String", # This is always `sql#sslCert`.
+      "selfLink": "A String", # The URI of this resource.
+      "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+    },
+  ],
+}
+
+ +
+ RotateServerCertificate(project, instance, body=None, x__xgafv=None) +
Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, please use RotateServerCa instead.
+
+Args:
+  project: string, Required. Project ID of the project that contains the instance. (required)
+  instance: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Rotate Server Certificate request.
+  "rotateServerCertificateContext": { # Instance rotate server certificate context. # Optional. Contains details about the rotate server CA operation.
+    "kind": "A String", # Optional. This is always `sql#rotateServerCertificateContext`.
+    "nextVersion": "A String", # Optional. The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
+  "acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
+    "duration": "A String", # Lease duration needed for the SSRS setup.
+    "reportDatabase": "A String", # The report database to be used for the SSRS setup.
+    "serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
+    "setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
+  },
+  "apiWarning": { # An Admin API warning message. # An Admin API warning message.
+    "code": "A String", # Code to uniquely identify the warning type.
+    "message": "A String", # The warning message.
+    "region": "A String", # The region name for REGION_UNREACHABLE warning.
+  },
+  "backupContext": { # Backup context. # The context for backup operation, if applicable.
+    "backupId": "A String", # The identifier of the backup.
+    "kind": "A String", # This is always `sql#backupContext`.
+  },
+  "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+    "errors": [ # The list of errors encountered while processing this operation.
+      { # Database instance operation error.
+        "code": "A String", # Identifies the specific error that occurred.
+        "kind": "A String", # This is always `sql#operationError`.
+        "message": "A String", # Additional information about the error encountered.
+      },
+    ],
+    "kind": "A String", # This is always `sql#operationErrors`.
+  },
+  "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+    "bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
+      "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
+      "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
+      "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
+      "exportLogEndTime": "A String", # Optional. The end timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs until current time will be included. Only applied to Cloud SQL for SQL Server.
+      "exportLogStartTime": "A String", # Optional. The begin timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs from the beginning of retention period will be included. Only applied to Cloud SQL for SQL Server.
+      "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
+      "striped": True or False, # Whether or not the export should be striped.
+    },
+    "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "selectQuery": "A String", # The select query used to extract the data.
+    },
+    "databases": [ # Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
+      "A String",
+    ],
+    "fileType": "A String", # The file type for the specified uri.
+    "kind": "A String", # This is always `sql#exportContext`.
+    "offload": True or False, # Option for export offload.
+    "sqlExportOptions": { # Options for exporting data as SQL statements.
+      "mysqlExportOptions": { # Options for exporting from MySQL.
+        "masterData": 42, # Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.
+      },
+      "parallel": True or False, # Optional. Whether or not the export should be parallel.
+      "postgresExportOptions": { # Options for exporting from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. Use this option to include DROP SQL statements. These statements are used to delete database objects before running the import operation.
+        "ifExists": True or False, # Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.
+      },
+      "schemaOnly": True or False, # Export only schemas.
+      "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
+        "A String",
+      ],
+      "threads": 42, # Optional. The number of threads to use for parallel export.
+    },
+    "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
+  },
+  "importContext": { # Database instance import context. # The context for import operation, if applicable.
+    "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+      "bakType": "A String", # Type of the bak content, FULL or DIFF.
+      "encryptionOptions": {
+        "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+        "pvkPassword": "A String", # Password that encrypts the private key
+        "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+      },
+      "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
+      "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
+      "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
+      "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
+      "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
+    },
+    "csvImportOptions": { # Options for importing data as CSV.
+      "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
+        "A String",
+      ],
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "table": "A String", # The table to which CSV data is imported.
+    },
+    "database": "A String", # The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified.
+    "fileType": "A String", # The file type for the specified uri. * `SQL`: The file contains SQL statements. * `CSV`: The file contains CSV data. * `BAK`: The file contains backup data for a SQL Server instance.
+    "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+    "kind": "A String", # This is always `sql#importContext`.
+    "sqlImportOptions": { # Optional. Options for importing data from SQL statements.
+      "parallel": True or False, # Optional. Whether or not the import should be parallel.
+      "postgresImportOptions": { # Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+        "ifExists": True or False, # Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+      },
+      "threads": 42, # Optional. The number of threads to use for parallel import.
+    },
+    "uri": "A String", # Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
+  },
+  "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "kind": "A String", # This is always `sql#operation`.
+  "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
+  "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "selfLink": "A String", # The URI of this resource.
+  "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "status": "A String", # The status of an operation.
+  "targetId": "A String", # Name of the database instance related to this operation.
+  "targetLink": "A String",
+  "targetProject": "A String", # The project ID of the target instance related to this operation.
+  "user": "A String", # The email address of the user who initiated this operation.
+}
+
+
acquireSsrsLease(project, instance, body=None, x__xgafv=None)
Acquire a lease for the setup of SQL Server Reporting Services (SSRS).
@@ -325,6 +525,140 @@ 

Method Details

}
+
+ addServerCertificate(project, instance, x__xgafv=None) +
Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, please use AddServerCa instead.
+
+Args:
+  project: string, Required. Project ID of the project that contains the instance. (required)
+  instance: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
+  "acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
+    "duration": "A String", # Lease duration needed for the SSRS setup.
+    "reportDatabase": "A String", # The report database to be used for the SSRS setup.
+    "serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
+    "setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
+  },
+  "apiWarning": { # An Admin API warning message. # An Admin API warning message.
+    "code": "A String", # Code to uniquely identify the warning type.
+    "message": "A String", # The warning message.
+    "region": "A String", # The region name for REGION_UNREACHABLE warning.
+  },
+  "backupContext": { # Backup context. # The context for backup operation, if applicable.
+    "backupId": "A String", # The identifier of the backup.
+    "kind": "A String", # This is always `sql#backupContext`.
+  },
+  "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+    "errors": [ # The list of errors encountered while processing this operation.
+      { # Database instance operation error.
+        "code": "A String", # Identifies the specific error that occurred.
+        "kind": "A String", # This is always `sql#operationError`.
+        "message": "A String", # Additional information about the error encountered.
+      },
+    ],
+    "kind": "A String", # This is always `sql#operationErrors`.
+  },
+  "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+    "bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
+      "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
+      "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
+      "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
+      "exportLogEndTime": "A String", # Optional. The end timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs until current time will be included. Only applied to Cloud SQL for SQL Server.
+      "exportLogStartTime": "A String", # Optional. The begin timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs from the beginning of retention period will be included. Only applied to Cloud SQL for SQL Server.
+      "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
+      "striped": True or False, # Whether or not the export should be striped.
+    },
+    "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "selectQuery": "A String", # The select query used to extract the data.
+    },
+    "databases": [ # Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
+      "A String",
+    ],
+    "fileType": "A String", # The file type for the specified uri.
+    "kind": "A String", # This is always `sql#exportContext`.
+    "offload": True or False, # Option for export offload.
+    "sqlExportOptions": { # Options for exporting data as SQL statements.
+      "mysqlExportOptions": { # Options for exporting from MySQL.
+        "masterData": 42, # Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.
+      },
+      "parallel": True or False, # Optional. Whether or not the export should be parallel.
+      "postgresExportOptions": { # Options for exporting from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. Use this option to include DROP SQL statements. These statements are used to delete database objects before running the import operation.
+        "ifExists": True or False, # Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.
+      },
+      "schemaOnly": True or False, # Export only schemas.
+      "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
+        "A String",
+      ],
+      "threads": 42, # Optional. The number of threads to use for parallel export.
+    },
+    "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
+  },
+  "importContext": { # Database instance import context. # The context for import operation, if applicable.
+    "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+      "bakType": "A String", # Type of the bak content, FULL or DIFF.
+      "encryptionOptions": {
+        "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+        "pvkPassword": "A String", # Password that encrypts the private key
+        "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+      },
+      "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
+      "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
+      "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
+      "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
+      "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
+    },
+    "csvImportOptions": { # Options for importing data as CSV.
+      "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
+        "A String",
+      ],
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "table": "A String", # The table to which CSV data is imported.
+    },
+    "database": "A String", # The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified.
+    "fileType": "A String", # The file type for the specified uri. * `SQL`: The file contains SQL statements. * `CSV`: The file contains CSV data. * `BAK`: The file contains backup data for a SQL Server instance.
+    "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+    "kind": "A String", # This is always `sql#importContext`.
+    "sqlImportOptions": { # Optional. Options for importing data from SQL statements.
+      "parallel": True or False, # Optional. Whether or not the import should be parallel.
+      "postgresImportOptions": { # Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+        "ifExists": True or False, # Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+      },
+      "threads": 42, # Optional. The number of threads to use for parallel import.
+    },
+    "uri": "A String", # Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
+  },
+  "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "kind": "A String", # This is always `sql#operation`.
+  "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
+  "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "selfLink": "A String", # The URI of this resource.
+  "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "status": "A String", # The status of an operation.
+  "targetId": "A String", # Name of the database instance related to this operation.
+  "targetLink": "A String",
+  "targetProject": "A String", # The project ID of the target instance related to this operation.
+  "user": "A String", # The email address of the user who initiated this operation.
+}
+
+
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.
diff --git a/docs/dyn/vision_v1.files.html b/docs/dyn/vision_v1.files.html
index 9ffeea128de..25bf04de2fc 100644
--- a/docs/dyn/vision_v1.files.html
+++ b/docs/dyn/vision_v1.files.html
@@ -271,7 +271,7 @@ 

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1.images.html b/docs/dyn/vision_v1.images.html index 5f98490b46e..786b7c2d4ff 100644 --- a/docs/dyn/vision_v1.images.html +++ b/docs/dyn/vision_v1.images.html @@ -250,7 +250,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1.projects.files.html b/docs/dyn/vision_v1.projects.files.html index 43068fae1b0..8d54e6ac1c9 100644 --- a/docs/dyn/vision_v1.projects.files.html +++ b/docs/dyn/vision_v1.projects.files.html @@ -272,7 +272,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1.projects.images.html b/docs/dyn/vision_v1.projects.images.html index d6b7f5199bb..57c06788839 100644 --- a/docs/dyn/vision_v1.projects.images.html +++ b/docs/dyn/vision_v1.projects.images.html @@ -251,7 +251,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1.projects.locations.files.html b/docs/dyn/vision_v1.projects.locations.files.html index 6638ba6ad55..806ddf1a2dd 100644 --- a/docs/dyn/vision_v1.projects.locations.files.html +++ b/docs/dyn/vision_v1.projects.locations.files.html @@ -272,7 +272,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1.projects.locations.images.html b/docs/dyn/vision_v1.projects.locations.images.html index 12f502b7e0b..db01f52b6bd 100644 --- a/docs/dyn/vision_v1.projects.locations.images.html +++ b/docs/dyn/vision_v1.projects.locations.images.html @@ -251,7 +251,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p1beta1.files.html b/docs/dyn/vision_v1p1beta1.files.html index 9190bfc2055..23b04ec73fa 100644 --- a/docs/dyn/vision_v1p1beta1.files.html +++ b/docs/dyn/vision_v1p1beta1.files.html @@ -271,7 +271,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p1beta1.images.html b/docs/dyn/vision_v1p1beta1.images.html index 4386d5d4ac8..48deaf5dee5 100644 --- a/docs/dyn/vision_v1p1beta1.images.html +++ b/docs/dyn/vision_v1p1beta1.images.html @@ -250,7 +250,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p1beta1.projects.files.html b/docs/dyn/vision_v1p1beta1.projects.files.html index fcf9326dbee..c711a07ee17 100644 --- a/docs/dyn/vision_v1p1beta1.projects.files.html +++ b/docs/dyn/vision_v1p1beta1.projects.files.html @@ -272,7 +272,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p1beta1.projects.images.html b/docs/dyn/vision_v1p1beta1.projects.images.html index 19d339a2dba..27772a15d11 100644 --- a/docs/dyn/vision_v1p1beta1.projects.images.html +++ b/docs/dyn/vision_v1p1beta1.projects.images.html @@ -251,7 +251,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p1beta1.projects.locations.files.html b/docs/dyn/vision_v1p1beta1.projects.locations.files.html index f3840e1bb43..ce3a509455d 100644 --- a/docs/dyn/vision_v1p1beta1.projects.locations.files.html +++ b/docs/dyn/vision_v1p1beta1.projects.locations.files.html @@ -272,7 +272,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p1beta1.projects.locations.images.html b/docs/dyn/vision_v1p1beta1.projects.locations.images.html index ed8a49a1672..3b375a17092 100644 --- a/docs/dyn/vision_v1p1beta1.projects.locations.images.html +++ b/docs/dyn/vision_v1p1beta1.projects.locations.images.html @@ -251,7 +251,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p2beta1.files.html b/docs/dyn/vision_v1p2beta1.files.html index e7e91916780..09e83fa6eb8 100644 --- a/docs/dyn/vision_v1p2beta1.files.html +++ b/docs/dyn/vision_v1p2beta1.files.html @@ -271,7 +271,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p2beta1.images.html b/docs/dyn/vision_v1p2beta1.images.html index 5a75a4e9e73..1903510f3ed 100644 --- a/docs/dyn/vision_v1p2beta1.images.html +++ b/docs/dyn/vision_v1p2beta1.images.html @@ -250,7 +250,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p2beta1.projects.files.html b/docs/dyn/vision_v1p2beta1.projects.files.html index 75e224df9e8..616dd2b9c98 100644 --- a/docs/dyn/vision_v1p2beta1.projects.files.html +++ b/docs/dyn/vision_v1p2beta1.projects.files.html @@ -272,7 +272,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p2beta1.projects.images.html b/docs/dyn/vision_v1p2beta1.projects.images.html index 0dc693c55c6..204d3714341 100644 --- a/docs/dyn/vision_v1p2beta1.projects.images.html +++ b/docs/dyn/vision_v1p2beta1.projects.images.html @@ -251,7 +251,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p2beta1.projects.locations.files.html b/docs/dyn/vision_v1p2beta1.projects.locations.files.html index c025d7d84ab..b81f3d05cd4 100644 --- a/docs/dyn/vision_v1p2beta1.projects.locations.files.html +++ b/docs/dyn/vision_v1p2beta1.projects.locations.files.html @@ -272,7 +272,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/docs/dyn/vision_v1p2beta1.projects.locations.images.html b/docs/dyn/vision_v1p2beta1.projects.locations.images.html index 06e1a4c72f8..7759bae1963 100644 --- a/docs/dyn/vision_v1p2beta1.projects.locations.images.html +++ b/docs/dyn/vision_v1p2beta1.projects.locations.images.html @@ -251,7 +251,7 @@

Method Details

"joyLikelihood": "A String", # Joy likelihood. "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1]. "landmarks": [ # Detected face landmarks. - { # A face-specific landmark (for example, a face feature). + { # A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. "position": { # A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. # Face landmark position. "x": 3.14, # X coordinate. "y": 3.14, # Y coordinate. diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index b4dad8e4008..4c277216f11 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -4671,7 +4671,7 @@ } } }, -"revision": "20240709", +"revision": "20240903", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -6245,7 +6245,7 @@ false "type": "string" }, "payload": { -"description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. * `REBOOT`: Payload is a stringified JSON object in the form: { \"user_session_delay_seconds\": 300 }. The delay has to be in the range [0, 300]. * `FETCH_SUPPORT_PACKET`: Payload is optionally a stringified JSON object in the form: {\"supportPacketDetails\":{ \"issueCaseId\": optional_support_case_id_string, \"issueDescription\": optional_issue_description_string, \"requestedDataCollectors\": []}} The list of available `data_collector_enums` are as following: Chrome System Information (1), Crash IDs (2), Memory Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9), Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12), ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14), Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS Virtual Keyboard (22), ChromeOS Network Health (23). See more details in [help article](https://support.google.com/chrome/a?p=remote-log).", +"description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true, \"crdSessionType\": string }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. `crdSessionType` can only select from values `private` (which grants the remote admin exclusive control of the ChromeOS device) or `shared` (which allows the admin and the local user to share control of the ChromeOS device). If not set, `crdSessionType` defaults to `shared`. * `REBOOT`: Payload is a stringified JSON object in the form: { \"user_session_delay_seconds\": 300 }. The `user_session_delay_seconds` is the amount of seconds to wait before rebooting the device if a user is logged in. It has to be an integer in the range [0,300]. When payload is not present for reboot, 0 delay is the default. Note: This only applies if an actual user is logged in, including a Guest. If the device is in the login screen or in Kiosk mode the value is not respected and the device immediately reboots. * `FETCH_SUPPORT_PACKET`: Payload is optionally a stringified JSON object in the form: {\"supportPacketDetails\":{ \"issueCaseId\": optional_support_case_id_string, \"issueDescription\": optional_issue_description_string, \"requestedDataCollectors\": []}} The list of available `data_collector_enums` are as following: Chrome System Information (1), Crash IDs (2), Memory Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9), Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12), ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14), Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS Virtual Keyboard (22), ChromeOS Network Health (23). See more details in [help article](https://support.google.com/chrome/a?p=remote-log).", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index f30002cfa6f..e0ef73e0f99 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -2246,7 +2246,7 @@ "annotations": { "methods": { "list": { -"description": "Lists Annotations belongs to a dataitem", +"description": "Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", "httpMethod": "GET", "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", @@ -4956,6 +4956,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}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.featureOnlineStores.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/[^/]+/featureOnlineStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists FeatureOnlineStores in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", @@ -5035,6 +5066,65 @@ "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}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.featureOnlineStores.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/[^/]+/featureOnlineStores/[^/]+$", +"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}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"permissions": { +"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", +"location": "query", +"repeated": true, +"type": "string" +}, +"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/[^/]+/featureOnlineStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -5156,6 +5246,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}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.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/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists FeatureViews in a given FeatureOnlineStore.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", @@ -5264,6 +5385,34 @@ "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}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.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/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "sync": { "description": "Triggers on-demand sync for the FeatureView.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", @@ -5291,6 +5440,37 @@ "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}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"permissions": { +"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", +"location": "query", +"repeated": true, +"type": "string" +}, +"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/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -17580,7 +17760,7 @@ } } }, -"revision": "20240816", +"revision": "20240828", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -22872,6 +23052,10 @@ "$ref": "GoogleCloudAiplatformV1BigQuerySource", "description": "Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View." }, +"dense": { +"description": "Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores.", +"type": "boolean" +}, "entityIdColumns": { "description": "Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`.", "items": { @@ -22879,6 +23063,10 @@ }, "type": "array" }, +"staticDataSource": { +"description": "Optional. Set if the data source is not a time-series.", +"type": "boolean" +}, "timeSeries": { "$ref": "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries", "description": "Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary." @@ -23292,6 +23480,10 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"vertexRagSource": { +"$ref": "GoogleCloudAiplatformV1FeatureViewVertexRagSource", +"description": "Optional. The Vertex RAG Source that the FeatureView is linked to." } }, "type": "object" @@ -23525,6 +23717,22 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1FeatureViewVertexRagSource": { +"description": "A Vertex Rag source for features that need to be synced to Online Store.", +"id": "GoogleCloudAiplatformV1FeatureViewVertexRagSource", +"properties": { +"ragCorpusId": { +"description": "Optional. The RAG corpus id corresponding to this FeatureView.", +"format": "int64", +"type": "string" +}, +"uri": { +"description": "Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1Featurestore": { "description": "Vertex AI Feature Store provides a centralized repository for organizing, storing, and serving ML features. The Featurestore is a top-level container for your features and their values.", "id": "GoogleCloudAiplatformV1Featurestore", @@ -24178,6 +24386,10 @@ "parameters": { "$ref": "GoogleCloudAiplatformV1Schema", "description": "Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1Schema", +"description": "Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function." } }, "type": "object" @@ -24195,7 +24407,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Required. The function response in JSON object format.", +"description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.", "type": "object" } }, @@ -24344,6 +24556,7 @@ "type": "integer" }, "totalTokenCount": { +"description": "Total token count for prompt and response candidates.", "format": "int32", "type": "integer" } @@ -32427,7 +32640,7 @@ false "LOW_COST", "STANDARD", "SPOT", -"DWS_FLEX_START" +"FLEX_START" ], "enumDeprecated": [ false, @@ -32443,7 +32656,7 @@ false "Deprecated. Low cost by making potential use of spot resources.", "Standard provisioning strategy uses regular on-demand resources.", "Spot provisioning strategy uses spot resources.", -"DWS Flex start strategy uses DWS to queue for resources." +"Flex Start strategy uses DWS to queue for resources." ], "type": "string" }, @@ -32456,7 +32669,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1Schema": { -"description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed.", +"description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed.", "id": "GoogleCloudAiplatformV1Schema", "properties": { "default": { @@ -37859,7 +38072,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1SyncFeatureViewResponse": { -"description": "Respose message for FeatureOnlineStoreAdminService.SyncFeatureView.", +"description": "Response message for FeatureOnlineStoreAdminService.SyncFeatureView.", "id": "GoogleCloudAiplatformV1SyncFeatureViewResponse", "properties": { "featureViewSync": { diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index cb353ea5208..5593732e89d 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -2836,7 +2836,7 @@ "annotations": { "methods": { "list": { -"description": "Lists Annotations belongs to a dataitem", +"description": "Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", "httpMethod": "GET", "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", @@ -5714,7 +5714,8 @@ "$ref": "GoogleCloudAiplatformV1beta1ListExtensionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "patch": { @@ -16493,6 +16494,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Updates a RagCorpus.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.ragCorpora.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. The resource name of the RagCorpus.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1RagCorpus" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -21058,7 +21087,7 @@ } } }, -"revision": "20240816", +"revision": "20240828", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -21614,6 +21643,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ApiAuth": { +"description": "The generic reusable api auth config.", +"id": "GoogleCloudAiplatformV1beta1ApiAuth", +"properties": { +"apiKeyConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", +"description": "The API secret." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig": { "description": "The API secret.", "id": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", @@ -22854,6 +22894,43 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"usageMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1CachedContentUsageMetadata", +"description": "Output only. Metadata on the usage of the cached content.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1CachedContentUsageMetadata": { +"description": "Metadata on the usage of the cached content.", +"id": "GoogleCloudAiplatformV1beta1CachedContentUsageMetadata", +"properties": { +"audioDurationSeconds": { +"description": "Duration of audio in seconds.", +"format": "int32", +"type": "integer" +}, +"imageCount": { +"description": "Number of images.", +"format": "int32", +"type": "integer" +}, +"textCount": { +"description": "Number of text characters.", +"format": "int32", +"type": "integer" +}, +"totalTokenCount": { +"description": "Total number of tokens that the cached content consumes.", +"format": "int32", +"type": "integer" +}, +"videoDurationSeconds": { +"description": "Duration of video in seconds.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -23400,6 +23477,35 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1CorpusStatus": { +"description": "RagCorpus status.", +"id": "GoogleCloudAiplatformV1beta1CorpusStatus", +"properties": { +"errorStatus": { +"description": "Output only. Only when the `state` field is ERROR.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. RagCorpus life state.", +"enum": [ +"UNKNOWN", +"INITIALIZED", +"ACTIVE", +"ERROR" +], +"enumDescriptions": [ +"This state is not supposed to happen.", +"RagCorpus resource entry is initialized, but hasn't done validation.", +"RagCorpus is provisioned successfully and is ready to serve.", +"RagCorpus is in a problematic situation. See `error_message` field for details." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1CountTokensRequest": { "description": "Request message for PredictionService.CountTokens.", "id": "GoogleCloudAiplatformV1beta1CountTokensRequest", @@ -27086,6 +27192,10 @@ "$ref": "GoogleCloudAiplatformV1beta1BigQuerySource", "description": "Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View." }, +"dense": { +"description": "Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores.", +"type": "boolean" +}, "entityIdColumns": { "description": "Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`.", "items": { @@ -27093,6 +27203,10 @@ }, "type": "array" }, +"staticDataSource": { +"description": "Optional. Set if the data source is not a time-series.", +"type": "boolean" +}, "timeSeries": { "$ref": "GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries", "description": "Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary." @@ -27547,6 +27661,10 @@ "$ref": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig", "deprecated": true, "description": "Optional. Deprecated: please use FeatureView.index_config instead." +}, +"vertexRagSource": { +"$ref": "GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource", +"description": "Optional. The Vertex RAG Source that the FeatureView is linked to." } }, "type": "object" @@ -27848,6 +27966,22 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource": { +"description": "A Vertex Rag source for features that need to be synced to Online Store.", +"id": "GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource", +"properties": { +"ragCorpusId": { +"description": "Optional. The RAG corpus id corresponding to this FeatureView.", +"format": "int64", +"type": "string" +}, +"uri": { +"description": "Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Featurestore": { "description": "Vertex AI Feature Store provides a centralized repository for organizing, storing, and serving ML features. The Featurestore is a top-level container for your features and their values.", "id": "GoogleCloudAiplatformV1beta1Featurestore", @@ -28172,6 +28306,33 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1FileStatus": { +"description": "RagFile status.", +"id": "GoogleCloudAiplatformV1beta1FileStatus", +"properties": { +"errorStatus": { +"description": "Output only. Only when the `state` field is ERROR.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. RagFile state.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"ERROR" +], +"enumDescriptions": [ +"RagFile state is unspecified.", +"RagFile resource has been created and indexed successfully.", +"RagFile resource is in a problematic state. See `error_message` field for details." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1FilterSplit": { "description": "Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as '-' (the minus sign). Supported only for unstructured Datasets. ", "id": "GoogleCloudAiplatformV1beta1FilterSplit", @@ -28548,7 +28709,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Required. The function response in JSON object format.", +"description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.", "type": "object" } }, @@ -28725,6 +28886,12 @@ "description": "Usage metadata about response(s).", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata", "properties": { +"cachedContentTokenCount": { +"description": "Output only. Number of tokens in the cached part in the input (the cached content).", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "candidatesTokenCount": { "description": "Number of tokens in the response(s).", "format": "int32", @@ -28736,6 +28903,7 @@ "type": "integer" }, "totalTokenCount": { +"description": "Total token count for prompt and response candidates.", "format": "int32", "type": "integer" } @@ -37054,6 +37222,11 @@ false "description": "A RagCorpus is a RagFile container and a project can have multiple RagCorpora.", "id": "GoogleCloudAiplatformV1beta1RagCorpus", "properties": { +"corpusStatus": { +"$ref": "GoogleCloudAiplatformV1beta1CorpusStatus", +"description": "Output only. RagCorpus state.", +"readOnly": true +}, "createTime": { "description": "Output only. Timestamp when this RagCorpus was created.", "format": "google-datetime", @@ -37077,6 +37250,10 @@ false "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig", "description": "Optional. Immutable. The embedding model config of the RagCorpus." }, +"ragVectorDbConfig": { +"$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfig", +"description": "Optional. Immutable. The Vector DB config of the RagCorpus." +}, "updateTime": { "description": "Output only. Timestamp when this RagCorpus was last updated.", "format": "google-datetime", @@ -37192,6 +37369,11 @@ false "description": "Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, +"fileStatus": { +"$ref": "GoogleCloudAiplatformV1beta1FileStatus", +"description": "Output only. State of the RagFile.", +"readOnly": true +}, "gcsSource": { "$ref": "GoogleCloudAiplatformV1beta1GcsSource", "description": "Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.", @@ -37305,6 +37487,61 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1RagVectorDbConfig": { +"description": "Config for the Vector DB to use for RAG.", +"id": "GoogleCloudAiplatformV1beta1RagVectorDbConfig", +"properties": { +"apiAuth": { +"$ref": "GoogleCloudAiplatformV1beta1ApiAuth", +"description": "Authentication config for the chosen Vector DB." +}, +"ragManagedDb": { +"$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb", +"description": "The config for the RAG-managed Vector DB." +}, +"vertexFeatureStore": { +"$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore", +"description": "The config for the Vertex Feature Store." +}, +"weaviate": { +"$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate", +"description": "The config for the Weaviate." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb": { +"description": "The config for the default RAG-managed Vector DB.", +"id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore": { +"description": "The config for the Vertex Feature Store.", +"id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore", +"properties": { +"featureViewResourceName": { +"description": "The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate": { +"description": "The config for the Weaviate.", +"id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate", +"properties": { +"collectionName": { +"description": "The corresponding collection this corpus maps to. This value cannot be changed after it's set.", +"type": "string" +}, +"httpEndpoint": { +"description": "Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1RawPredictRequest": { "description": "Request message for PredictionService.RawPredict.", "id": "GoogleCloudAiplatformV1beta1RawPredictRequest", @@ -38688,7 +38925,7 @@ false "LOW_COST", "STANDARD", "SPOT", -"DWS_FLEX_START" +"FLEX_START" ], "enumDeprecated": [ false, @@ -38704,7 +38941,7 @@ false "Deprecated. Low cost by making potential use of spot resources.", "Standard provisioning strategy uses regular on-demand resources.", "Spot provisioning strategy uses spot resources.", -"DWS Flex start strategy uses DWS to queue for resources." +"Flex Start strategy uses DWS to queue for resources." ], "type": "string" }, @@ -38717,7 +38954,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1Schema": { -"description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed.", +"description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed.", "id": "GoogleCloudAiplatformV1beta1Schema", "properties": { "default": { @@ -44282,7 +44519,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse": { -"description": "Respose message for FeatureOnlineStoreAdminService.SyncFeatureView.", +"description": "Response message for FeatureOnlineStoreAdminService.SyncFeatureView.", "id": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse", "properties": { "featureViewSync": { diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 90574444b86..693202a2e79 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -735,6 +735,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"upgrade": { +"description": "Upgrades a single Cluster. Imperative only.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:upgrade", +"httpMethod": "PATCH", +"id": "alloydb.projects.locations.clusters.upgrade", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the cluster.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:upgrade", +"request": { +"$ref": "UpgradeClusterRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -1489,7 +1517,7 @@ } } }, -"revision": "20240823", +"revision": "20240828", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2063,12 +2091,16 @@ false "description": "Upgrade status of the cluster.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." @@ -2469,6 +2501,14 @@ false "readOnly": true, "type": "array" }, +"outboundPublicIpAddresses": { +"description": "Output only. All outbound public IP addresses configured for the instance.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "pscInstanceConfig": { "$ref": "PscInstanceConfig", "description": "Optional. The configuration for Private Service Connect (PSC) for the instance." @@ -2553,6 +2593,10 @@ false }, "type": "array" }, +"enableOutboundPublicIp": { +"description": "Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.", +"type": "boolean" +}, "enablePublicIp": { "description": "Optional. Enabling public ip for the instance.", "type": "boolean" @@ -2588,12 +2632,16 @@ false "description": "Upgrade status of the instance.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." @@ -3238,15 +3286,21 @@ false "STAGE_UNSPECIFIED", "ALLOYDB_PRECHECK", "PG_UPGRADE_CHECK", +"PREPARE_FOR_UPGRADE", "PRIMARY_INSTANCE_UPGRADE", -"READ_POOL_UPGRADE" +"READ_POOL_INSTANCES_UPGRADE", +"ROLLBACK", +"CLEANUP" ], "enumDescriptions": [ "Unspecified stage.", -"This stage is for the custom checks done before upgrade.", -"This stage is for `pg_upgrade --check` run before upgrade.", -"This stage is primary upgrade.", -"This stage is read pool upgrade." +"Pre-upgrade custom checks, not covered by pg_upgrade.", +"Pre-upgrade pg_upgrade checks.", +"Clone the original cluster.", +"Upgrade the primary instance(downtime).", +"This stage is read pool upgrade.", +"Rollback in case of critical failures.", +"Cleanup." ], "type": "string" }, @@ -3254,12 +3308,16 @@ false "description": "Status of the stage.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." @@ -4826,6 +4884,47 @@ false }, "type": "object" }, +"UpgradeClusterRequest": { +"description": "Upgrades a cluster.", +"id": "UpgradeClusterRequest", +"properties": { +"etag": { +"description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.", +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.", +"type": "boolean" +}, +"version": { +"description": "Required. The version the cluster is going to be upgraded to.", +"enum": [ +"DATABASE_VERSION_UNSPECIFIED", +"POSTGRES_13", +"POSTGRES_14", +"POSTGRES_15" +], +"enumDeprecated": [ +false, +true, +false, +false +], +"enumDescriptions": [ +"This is an unknown database version.", +"DEPRECATED - The database version is Postgres 13.", +"The database version is Postgres 14.", +"The database version is Postgres 15." +], +"type": "string" +} +}, +"type": "object" +}, "UpgradeClusterResponse": { "description": "UpgradeClusterResponse contains the response for upgrade cluster operation.", "id": "UpgradeClusterResponse", @@ -4845,12 +4944,16 @@ false "description": "Status of upgrade operation.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index bbc226b6688..e996eb8a21a 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -1517,7 +1517,7 @@ } } }, -"revision": "20240823", +"revision": "20240828", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2139,12 +2139,16 @@ false "description": "Upgrade status of the cluster.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." @@ -2731,12 +2735,16 @@ false "description": "Upgrade status of the instance.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." @@ -3427,15 +3435,21 @@ false "STAGE_UNSPECIFIED", "ALLOYDB_PRECHECK", "PG_UPGRADE_CHECK", +"PREPARE_FOR_UPGRADE", "PRIMARY_INSTANCE_UPGRADE", -"READ_POOL_UPGRADE" +"READ_POOL_INSTANCES_UPGRADE", +"ROLLBACK", +"CLEANUP" ], "enumDescriptions": [ "Unspecified stage.", -"This stage is for the custom checks done before upgrade.", -"This stage is for `pg_upgrade --check` run before upgrade.", -"This stage is primary upgrade.", -"This stage is read pool upgrade." +"Pre-upgrade custom checks, not covered by pg_upgrade.", +"Pre-upgrade pg_upgrade checks.", +"Clone the original cluster.", +"Upgrade the primary instance(downtime).", +"This stage is read pool upgrade.", +"Rollback in case of critical failures.", +"Cleanup." ], "type": "string" }, @@ -3443,12 +3457,16 @@ false "description": "Status of the stage.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." @@ -5102,12 +5120,16 @@ false "description": "Status of upgrade operation.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 8aea06739fb..e2d58f87663 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -735,6 +735,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"upgrade": { +"description": "Upgrades a single Cluster. Imperative only.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:upgrade", +"httpMethod": "PATCH", +"id": "alloydb.projects.locations.clusters.upgrade", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the cluster.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:upgrade", +"request": { +"$ref": "UpgradeClusterRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -1486,7 +1514,7 @@ } } }, -"revision": "20240823", +"revision": "20240828", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2092,12 +2120,16 @@ false "description": "Upgrade status of the cluster.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." @@ -2679,12 +2711,16 @@ false "description": "Upgrade status of the instance.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." @@ -3375,15 +3411,21 @@ false "STAGE_UNSPECIFIED", "ALLOYDB_PRECHECK", "PG_UPGRADE_CHECK", +"PREPARE_FOR_UPGRADE", "PRIMARY_INSTANCE_UPGRADE", -"READ_POOL_UPGRADE" +"READ_POOL_INSTANCES_UPGRADE", +"ROLLBACK", +"CLEANUP" ], "enumDescriptions": [ "Unspecified stage.", -"This stage is for the custom checks done before upgrade.", -"This stage is for `pg_upgrade --check` run before upgrade.", -"This stage is primary upgrade.", -"This stage is read pool upgrade." +"Pre-upgrade custom checks, not covered by pg_upgrade.", +"Pre-upgrade pg_upgrade checks.", +"Clone the original cluster.", +"Upgrade the primary instance(downtime).", +"This stage is read pool upgrade.", +"Rollback in case of critical failures.", +"Cleanup." ], "type": "string" }, @@ -3391,12 +3433,16 @@ false "description": "Status of the stage.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." @@ -4987,6 +5033,50 @@ false }, "type": "object" }, +"UpgradeClusterRequest": { +"description": "Upgrades a cluster.", +"id": "UpgradeClusterRequest", +"properties": { +"etag": { +"description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.", +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.", +"type": "boolean" +}, +"version": { +"description": "Required. The version the cluster is going to be upgraded to.", +"enum": [ +"DATABASE_VERSION_UNSPECIFIED", +"POSTGRES_13", +"POSTGRES_14", +"POSTGRES_15", +"POSTGRES_16" +], +"enumDeprecated": [ +false, +true, +false, +false, +false +], +"enumDescriptions": [ +"This is an unknown database version.", +"DEPRECATED - The database version is Postgres 13.", +"The database version is Postgres 14.", +"The database version is Postgres 15.", +"The database version is Postgres 16." +], +"type": "string" +} +}, +"type": "object" +}, "UpgradeClusterResponse": { "description": "UpgradeClusterResponse contains the response for upgrade cluster operation.", "id": "UpgradeClusterResponse", @@ -5006,12 +5096,16 @@ false "description": "Status of upgrade operation.", "enum": [ "STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "enumDescriptions": [ "Unspecified status.", +"Not started.", +"In progress.", "Operation succeeded.", "Operation failed.", "Operation partially succeeded." diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 4bbd84389d0..d959057e840 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1168,7 +1168,7 @@ } } }, -"revision": "20240821", +"revision": "20240904", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1206,6 +1206,22 @@ ], "type": "string" }, +"contentProtectionPolicy": { +"description": "Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above.", +"enum": [ +"CONTENT_PROTECTION_POLICY_UNSPECIFIED", +"CONTENT_PROTECTION_DISABLED", +"CONTENT_PROTECTION_ENFORCED", +"CONTENT_PROTECTION_USER_CHOICE" +], +"enumDescriptions": [ +"Unspecified. Defaults to CONTENT_PROTECTION_DISABLED.", +"Content protection is disabled and the user cannot change this.", +"Content protection is enabled and the user cannot change this.Supported on Android 15 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 15.", +"Content protection is not controlled by the policy. The user is allowed to choose the behavior of content protection.Supported on Android 15 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 15." +], +"type": "string" +}, "developerSettings": { "description": "Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated).", "enum": [ @@ -4853,6 +4869,20 @@ false }, "type": "array" }, +"assistContentPolicy": { +"description": "Optional. Controls whether AssistContent (https://developer.android.com/reference/android/app/assist/AssistContent) is allowed to be sent to a privileged app such as an assistant app. AssistContent includes screenshots and information about an app, such as package name. This is supported on Android 15 and above.", +"enum": [ +"ASSIST_CONTENT_POLICY_UNSPECIFIED", +"ASSIST_CONTENT_DISALLOWED", +"ASSIST_CONTENT_ALLOWED" +], +"enumDescriptions": [ +"Unspecified. Defaults to ASSIST_CONTENT_ALLOWED.", +"Assist content is blocked from being sent to a privileged app.Supported on Android 15 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 15.", +"Assist content is allowed to be sent to a privileged app.Supported on Android 15 and above." +], +"type": "string" +}, "autoDateAndTimeZone": { "description": "Whether auto date, time, and time zone are enabled on a company-owned device. If this is set, then autoTimeRequired is ignored.", "enum": [ @@ -5412,7 +5442,7 @@ false }, "wifiConfigsLockdownEnabled": { "deprecated": true, -"description": "DEPRECATED - Use wifi_config_disabled.", +"description": "This is deprecated.", "type": "boolean" } }, diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index b6bf7f88f19..7af9f873836 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -10045,7 +10045,7 @@ } } }, -"revision": "20240701", +"revision": "20240903", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -16617,6 +16617,13 @@ "$ref": "GoogleCloudApigeeV1SecurityActionAllow", "description": "Allow a request through if it matches this SecurityAction." }, +"apiProxies": { +"description": "Optional. If unset, this would apply to all proxies in the environment. If set, this action is enforced only if at least one proxy in the repeated list is deployed at the time of enforcement. If set, several restrictions are enforced on SecurityActions. There can be at most 100 enabled actions with proxies set in an env. Several other restrictions apply on conditions and are detailed later.", +"items": { +"type": "string" +}, +"type": "array" +}, "conditionConfig": { "$ref": "GoogleCloudApigeeV1SecurityActionConditionConfig", "description": "Required. A valid SecurityAction must contain at least one condition." diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index 93abb063c8a..6fbd78d3596 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -1718,7 +1718,7 @@ } } }, -"revision": "20240722", +"revision": "20240906", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -2480,6 +2480,24 @@ }, "type": "object" }, +"GceTag": { +"description": "For use only by GCE. GceTag is a wrapper around the GCE administrative tag with parent info.", +"id": "GceTag", +"properties": { +"parent": { +"description": "The parents(s) of the tag. Eg. projects/123, folders/456 It usually contains only one parent. But, in some corner cases, it can contain multiple parents. Currently, organizations are not supported.", +"items": { +"type": "string" +}, +"type": "array" +}, +"tag": { +"description": "The administrative_tag name.", +"type": "string" +} +}, +"type": "object" +}, "GoogleAppengineV1betaLocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleAppengineV1betaLocationMetadata", @@ -3343,6 +3361,13 @@ ], "type": "string" }, +"gceTag": { +"description": "The GCE tags associated with the consumer project and those inherited due to their ancestry, if any. Not supported by CCFE.", +"items": { +"$ref": "GceTag" +}, +"type": "array" +}, "p4ServiceAccount": { "description": "The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json index 16202d10d76..7e653ab84b5 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json @@ -946,7 +946,7 @@ } } }, -"revision": "20240708", +"revision": "20240906", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { @@ -1125,6 +1125,24 @@ "properties": {}, "type": "object" }, +"GceTag": { +"description": "For use only by GCE. GceTag is a wrapper around the GCE administrative tag with parent info.", +"id": "GceTag", +"properties": { +"parent": { +"description": "The parents(s) of the tag. Eg. projects/123, folders/456 It usually contains only one parent. But, in some corner cases, it can contain multiple parents. Currently, organizations are not supported.", +"items": { +"type": "string" +}, +"type": "array" +}, +"tag": { +"description": "The administrative_tag name.", +"type": "string" +} +}, +"type": "object" +}, "GoogleAppengineV1betaLocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleAppengineV1betaLocationMetadata", @@ -1551,6 +1569,13 @@ ], "type": "string" }, +"gceTag": { +"description": "The GCE tags associated with the consumer project and those inherited due to their ancestry, if any. Not supported by CCFE.", +"items": { +"$ref": "GceTag" +}, +"type": "array" +}, "p4ServiceAccount": { "description": "The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/appengine.v1beta.json b/googleapiclient/discovery_cache/documents/appengine.v1beta.json index 6e74f2a3027..b9a1777fbb4 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -1918,7 +1918,7 @@ } } }, -"revision": "20240722", +"revision": "20240906", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -2731,6 +2731,24 @@ }, "type": "object" }, +"GceTag": { +"description": "For use only by GCE. GceTag is a wrapper around the GCE administrative tag with parent info.", +"id": "GceTag", +"properties": { +"parent": { +"description": "The parents(s) of the tag. Eg. projects/123, folders/456 It usually contains only one parent. But, in some corner cases, it can contain multiple parents. Currently, organizations are not supported.", +"items": { +"type": "string" +}, +"type": "array" +}, +"tag": { +"description": "The administrative_tag name.", +"type": "string" +} +}, +"type": "object" +}, "GoogleAppengineV1betaLocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleAppengineV1betaLocationMetadata", @@ -3594,6 +3612,13 @@ ], "type": "string" }, +"gceTag": { +"description": "The GCE tags associated with the consumer project and those inherited due to their ancestry, if any. Not supported by CCFE.", +"items": { +"$ref": "GceTag" +}, +"type": "array" +}, "p4ServiceAccount": { "description": "The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index 1ddd9200410..bce2fd5edc4 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -679,7 +679,7 @@ ], "parameters": { "filter": { -"description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` Examples of using a filter: To filter the results of your request to repositories with the name \"my-repo\" in project my-project in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/*repo\"` * `name=\"projects/my-project/locations/us-central1/repositories/*repo*\"`", +"description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` Examples of using a filter: To filter the results of your request to repositories with the name `my-repo` in project `my-project` in the `us-central` region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/*repo\"` * `name=\"projects/my-project/locations/us-central1/repositories/*repo*\"`", "location": "query", "type": "string" }, @@ -1044,7 +1044,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name \"my_file.txt\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * \"annotations.external_link:external_link_value\" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-file`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name `my_file.txt` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `\"annotations.external_link:external_link_value\"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `\"annotations.external_link\"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * `` \"annotations.`external.link`:`https://example.com/my-file`\" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` \"annotations.*_link:`*example.com*`\" ``", "location": "query", "type": "string" }, @@ -1488,7 +1488,7 @@ ], "parameters": { "filter": { -"description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to packages with the name \"my-package\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/*package\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*\"` To filter the results of your request to packages with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request\": * \"annotations.external_link:external_link_value\" To filter the results just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [`external.link`:`https://example.com/my-package`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-package`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", +"description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to packages with the name `my-package` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/*package\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*\"` To filter the results of your request to packages with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request\": * `\"annotations.external_link:external_link_value\"` To filter the results just for a specific annotation key `external_link`, append the following filter expression to your request: * `\"annotations.external_link\"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [`external.link`:`https://example.com/my-package`], append the following filter expression to your request: * `` \"annotations.`external.link`:`https://example.com/my-package`\" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` \"annotations.*_link:`*example.com*`\" ``", "location": "query", "type": "string" }, @@ -1657,7 +1657,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name \"my-tag\" in package \"my-package\" in repository \"my-repo\" in project \"my-project\" in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name `my-tag` in package `my-package` in repository `my-repo` in project \"`y-project` in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", "location": "query", "type": "string" }, @@ -1836,7 +1836,7 @@ ], "parameters": { "filter": { -"description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to versions with the name \"my-version\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version*\"` To filter the results of your request to versions with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * \"annotations.external_link:external_link_value\" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to versions with the annotation key-value pair [`external.link`:`https://example.com/my-version`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-version`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", +"description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to versions with the name `my-version` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version*\"` To filter the results of your request to versions with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `\"annotations.external_link:external_link_value\"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `\"annotations.external_link\"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to versions with the annotation key-value pair [`external.link`:`https://example.com/my-version`], append the following filter expression to your request: * `` \"annotations.`external.link`:`https://example.com/my-version`\" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` \"annotations.*_link:`*example.com*`\" ``", "location": "query", "type": "string" }, @@ -2038,7 +2038,7 @@ } } }, -"revision": "20240826", +"revision": "20240903", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -2264,6 +2264,17 @@ }, "type": "object" }, +"CommonRemoteRepository": { +"description": "Common remote repository settings type.", +"id": "CommonRemoteRepository", +"properties": { +"uri": { +"description": "Required. A common public repository base for Remote Repository.", +"type": "string" +} +}, +"type": "object" +}, "DockerImage": { "description": "DockerImage represents a docker artifact. The following fields are returned as untyped metadata in the Version resource, using camelcase keys (i.e. metadata.imageSizeBytes): * imageSizeBytes * mediaType * buildTime", "id": "DockerImage", @@ -3457,6 +3468,10 @@ false "$ref": "AptRepository", "description": "Specific settings for an Apt remote repository." }, +"commonRepository": { +"$ref": "CommonRemoteRepository", +"description": "Common remote repository settings. Used as the RR upstream URL instead of Predefined and Custom remote repositories. UI and Gcloud will map all the new remote repositories to this field." +}, "description": { "description": "The description of the remote source.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json index a038e5b40f1..51e36e9b4a7 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json @@ -720,7 +720,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name \"my_file.txt\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * \"annotations.external_link:external_link_value\" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-file`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name `my_file.txt` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `\"annotations.external_link:external_link_value\"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `\"annotations.external_link\"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * `` \"annotations.`external.link`:`https://example.com/my-file`\" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` \"annotations.*_link:`*example.com*`\" ``", "location": "query", "type": "string" }, @@ -947,7 +947,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name \"my-tag\" in package \"my-package\" in repository \"my-repo\" in project \"my-project\" in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name `my-tag` in package `my-package` in repository `my-repo` in project \"`y-project` in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", "location": "query", "type": "string" }, @@ -1156,7 +1156,7 @@ } } }, -"revision": "20240826", +"revision": "20240903", "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 62b5968172c..8fc1252ffea 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -882,7 +882,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name \"my_file.txt\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * \"annotations.external_link:external_link_value\" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-file`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name `my_file.txt` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `\"annotations.external_link:external_link_value\"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `\"annotations.external_link\"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * `` \"annotations.`external.link`:`https://example.com/my-file`\" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` \"annotations.*_link:`*example.com*`\" ``", "location": "query", "type": "string" }, @@ -1143,7 +1143,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name \"my-tag\" in package \"my-package\" in repository \"my-repo\" in project \"my-project\" in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name `my-tag` in package `my-package` in repository `my-repo` in project \"`y-project` in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", "location": "query", "type": "string" }, @@ -1424,7 +1424,7 @@ } } }, -"revision": "20240826", +"revision": "20240903", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index d85fbbf4b36..2e6d0c4c03d 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -1598,7 +1598,7 @@ } } }, -"revision": "20240815", +"revision": "20240828", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -2668,6 +2668,13 @@ ], "type": "string" }, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Labels to apply to instances that are created from these properties.", +"type": "object" +}, "machineType": { "description": "The machine type to use for instances that are created from these properties.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json b/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json index c956338b1b8..11a06ae1007 100644 --- a/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json +++ b/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json @@ -1722,7 +1722,7 @@ } } }, -"revision": "20240626", +"revision": "20240830", "rootUrl": "https://baremetalsolution.googleapis.com/", "schemas": { "AllowedClient": { @@ -2847,7 +2847,7 @@ "type": "string" }, "vlanAttachments": { -"description": "List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan).", +"description": "List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf", "items": { "$ref": "IntakeVlanAttachment" }, @@ -2856,6 +2856,10 @@ "vlanSameProject": { "description": "Whether the VLAN attachment pair is located in the same project.", "type": "boolean" +}, +"vrf": { +"description": "Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty.", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 04a417ef771..7f804d932e3 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -1324,7 +1324,7 @@ } } }, -"revision": "20240825", +"revision": "20240829", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1736,6 +1736,25 @@ }, "type": "object" }, +"ChatSpaceLinkData": { +"description": "Data for Chat space links. [Developer Preview](https://developers.google.com/workspace/preview).", +"id": "ChatSpaceLinkData", +"properties": { +"message": { +"description": "The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`", +"type": "string" +}, +"space": { +"description": "The space of the linked Chat space resource. Format: `spaces/{space}`", +"type": "string" +}, +"thread": { +"description": "The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}`", +"type": "string" +} +}, +"type": "object" +}, "Color": { "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value\u2014for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", "id": "Color", @@ -1800,7 +1819,7 @@ "The add-on launches from Google Sheets.", "The add-on launches from Google Slides.", "The add-on launches from Google Drawings.", -"A Google Chat app." +"A Google Chat app. Not used for Google Workspace Add-ons." ], "type": "string" }, @@ -4046,6 +4065,10 @@ "description": "A rich link to a resource.", "id": "RichLinkMetadata", "properties": { +"chatSpaceLinkData": { +"$ref": "ChatSpaceLinkData", +"description": "Data for a chat space link. [Developer Preview](https://developers.google.com/workspace/preview)." +}, "driveLinkData": { "$ref": "DriveLinkData", "description": "Data for a drive link." @@ -4054,11 +4077,13 @@ "description": "The rich link type.", "enum": [ "RICH_LINK_TYPE_UNSPECIFIED", -"DRIVE_FILE" +"DRIVE_FILE", +"CHAT_SPACE" ], "enumDescriptions": [ "Default value for the enum. Don't use.", -"A Google Drive rich link type." +"A Google Drive rich link type.", +"A Chat space rich link type. For example, a space smart chip. [Developer Preview](https://developers.google.com/workspace/preview)." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/checks.v1alpha.json b/googleapiclient/discovery_cache/documents/checks.v1alpha.json index 95942cc43e5..c3e0d8e976c 100644 --- a/googleapiclient/discovery_cache/documents/checks.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/checks.v1alpha.json @@ -368,6 +368,36 @@ } } } +}, +"repos": { +"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/accounts/{accountsId}/repos/{reposId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "checks.accounts.repos.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^accounts/[^/]+/repos/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Operation" +} +} +} +} +} } } }, @@ -414,7 +444,7 @@ } } }, -"revision": "20240707", +"revision": "20240904", "rootUrl": "https://checks.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1.json index 7e23ff0aa79..e3aab0af7ee 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -358,59 +358,6 @@ }, "operations": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/operations/{operationsId}:cancel", -"httpMethod": "POST", -"id": "cloudasset.operations.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", -"location": "path", -"pattern": "^operations/.*$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:cancel", -"request": { -"$ref": "CancelOperationRequest" -}, -"response": { -"$ref": "Empty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/operations/{operationsId}", -"httpMethod": "DELETE", -"id": "cloudasset.operations.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be deleted.", -"location": "path", -"pattern": "^operations/.*$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "Empty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1/{v1Id}/{v1Id1}/operations/{operationsId}/{operationsId1}", @@ -1148,7 +1095,7 @@ } } }, -"revision": "20240823", +"revision": "20240831", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -1578,12 +1525,6 @@ }, "type": "object" }, -"CancelOperationRequest": { -"description": "The request message for Operations.CancelOperation.", -"id": "CancelOperationRequest", -"properties": {}, -"type": "object" -}, "ConditionContext": { "description": "The IAM conditions context.", "id": "ConditionContext", @@ -3526,7 +3467,7 @@ "AVAILABLE_PACKAGE" ], "enumDescriptions": [ -"Invalid. An type must be specified.", +"Invalid. A type must be specified.", "This represents a package that is installed on the VM.", "This represents an update that is available for a package." ], @@ -4207,7 +4148,7 @@ "type": "array" }, "enrichments": { -"description": "Enrichments of the asset. Currently supported enrichment types with SearchAllResources API: * RESOURCE_OWNERS The corresponding read masks in order to get the enrichment: * enrichments.resource_owners The corresponding required permissions: * cloudasset.assets.searchEnrichmentResourceOwners Example query to get resource owner enrichment: scope: \"projects/my-project\" query: \"name: my-project\" assetTypes: \"cloudresourcemanager.googleapis.com/Project\" readMask: { paths: \"asset_type\" paths: \"name\" paths: \"enrichments.resource_owners\" }", +"description": "Enrichments of the asset. Currently supported enrichment types with SearchAllResources API: * RESOURCE_OWNERS The corresponding read masks in order to get the enrichment: * enrichments.resource_owners The corresponding required permissions: * cloudasset.assets.searchEnrichmentResourceOwners Example query to get resource owner enrichment: ``` scope: \"projects/my-project\" query: \"name: my-project\" assetTypes: \"cloudresourcemanager.googleapis.com/Project\" readMask: { paths: \"asset_type\" paths: \"name\" paths: \"enrichments.resource_owners\" } ```", "items": { "$ref": "AssetEnrichment" }, diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index a310ee5549f..ffbebbde77f 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -2346,7 +2346,7 @@ } } }, -"revision": "20240704", +"revision": "20240903", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -3428,7 +3428,7 @@ false "type": "string" }, "serviceAccount": { -"description": "The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}`", +"description": "The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}`", "type": "string" }, "sourceToBuild": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index d51fa71444e..a1b27a446dc 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -1990,7 +1990,7 @@ } } }, -"revision": "20240820", +"revision": "20240902", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -3732,6 +3732,7 @@ "SERVICE_ACCOUNT", "GROUP", "SHARED_DRIVE", +"CBCM_BROWSER", "OTHER" ], "enumDescriptions": [ @@ -3740,6 +3741,7 @@ "Represents service account type.", "Represents group type.", "Represents Shared drive.", +"Represents a CBCM-managed Chrome Browser type.", "Represents other type." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index 67f9f5f5d3c..fbc5b84fe09 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -2015,7 +2015,7 @@ } } }, -"revision": "20240702", +"revision": "20240902", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -4557,6 +4557,7 @@ "SERVICE_ACCOUNT", "GROUP", "SHARED_DRIVE", +"CBCM_BROWSER", "OTHER" ], "enumDescriptions": [ @@ -4565,6 +4566,7 @@ "Represents service account type.", "Represents group type.", "Represents Shared drive.", +"Represents a CBCM-managed Chrome Browser type.", "Represents other type." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index f20aa29b404..74e45c372fe 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -78,6 +78,21 @@ "description": "Regional Endpoint", "endpointUrl": "https://cloudkms.us-west4.rep.googleapis.com/", "location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.us-west8.rep.googleapis.com/", +"location": "us-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.us-south1.rep.googleapis.com/", +"location": "us-south1" } ], "fullyEncodeReservedExpansion": true, @@ -2112,7 +2127,7 @@ } } }, -"revision": "20240808", +"revision": "20240903", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 7b2c7cc2f3a..61f96287d0f 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -26471,6 +26471,110 @@ }, "regionInstanceGroupManagerResizeRequests": { "methods": { +"cancel": { +"description": "Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", +"httpMethod": "POST", +"id": "compute.regionInstanceGroupManagerResizeRequests.cancel", +"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" +}, +"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" +}, +"resizeRequest": { +"description": "The name of the resize request to cancel. 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}/cancel", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"delete": { +"description": "Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"httpMethod": "DELETE", +"id": "compute.regionInstanceGroupManagerResizeRequests.delete", +"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" +}, +"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" +}, +"resizeRequest": { +"description": "The name of the resize request to delete. 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": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "get": { "description": "Returns all of the details about the specified resize request.", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", @@ -33995,6 +34099,125 @@ } } }, +"reservationBlocks": { +"methods": { +"get": { +"description": "Retrieves information about the specified reservation block.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", +"httpMethod": "GET", +"id": "compute.reservationBlocks.get", +"parameterOrder": [ +"project", +"zone", +"reservation", +"reservationBlock" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"reservation": { +"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"reservationBlock": { +"description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", +"response": { +"$ref": "ReservationBlocksGetResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Retrieves a list of reservation blocks under a single reservation.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", +"httpMethod": "GET", +"id": "compute.reservationBlocks.list", +"parameterOrder": [ +"project", +"zone", +"reservation" +], +"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", +"required": true, +"type": "string" +}, +"reservation": { +"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"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": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", +"response": { +"$ref": "ReservationBlocksListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "reservations": { "methods": { "aggregatedList": { @@ -45055,7 +45278,7 @@ } } }, -"revision": "20240820", +"revision": "20240827", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -46471,6 +46694,11 @@ false "description": "[Output Only] Contains output only fields.", "id": "AllocationResourceStatus", "properties": { +"reservationBlockCount": { +"description": "Indicates number of blocks for accelerator optimized family (applicable beyond A3 only).", +"format": "int32", +"type": "integer" +}, "specificSkuAllocation": { "$ref": "AllocationResourceStatusSpecificSKUAllocation", "description": "Allocation Properties of this reservation." @@ -81920,6 +82148,20 @@ false "description": "Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.", "type": "string" }, +"deploymentType": { +"description": "Specifies the deployment strategy for this reservation.", +"enum": [ +"DENSE", +"DEPLOYMENT_TYPE_UNSPECIFIED", +"FLEXIBLE" +], +"enumDescriptions": [ +"Number of deployment blocks, size, and topology is fixed during creation and does not change over time. Deployment will be expressed in terms of blocks.", +"Deployment type is unspecified.", +"Distribution of capacity in blocks is not static and can change over time. This is expected to have more obtainability over DENSE deployment. Deployment will not be expressed in terms of blocks." +], +"type": "string" +}, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -81929,6 +82171,20 @@ false "format": "uint64", "type": "string" }, +"instanceTerminationAction": { +"description": "Instance termination action that will be invoked when the reservation is deleted.", +"enum": [ +"DELETE", +"INSTANCE_TERMINATION_ACTION_UNSPECIFIED", +"STOP" +], +"enumDescriptions": [ +"Delete the VM.", +"Default value. This value is unused.", +"Stop the VM without storing in-memory content. default action." +], +"type": "string" +}, "kind": { "default": "compute#reservation", "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.", @@ -82206,6 +82462,233 @@ false }, "type": "object" }, +"ReservationBlock": { +"description": "Represents a reservation block resource.", +"id": "ReservationBlock", +"properties": { +"count": { +"description": "[Output Only] Specifies the number of resources that are allocated in this block. It indicates the maximum number of VMs that a user can run on this particular block.", +"format": "int32", +"type": "integer" +}, +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"format": "uint64", +"type": "string" +}, +"inUseCount": { +"description": "[Output Only] Indicates how many instances are in use on this block.", +"format": "int32", +"type": "integer" +}, +"kind": { +"description": "[Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks.", +"type": "string" +}, +"locationPrefix": { +"description": "[Output Only] Obfuscated location where this reservation block physically resides in format /CCCC/GGGG. This matches the tripod specified in the VM topology information. Example: /USEAB1/0101/ is the location prefix in /USEAB1/0101/031/003", +"type": "string" +}, +"name": { +"description": "[Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined fully-qualified URL for this resource.", +"type": "string" +}, +"selfLinkWithId": { +"description": "[Output Only] Server-defined URL for this resource with the resource id.", +"type": "string" +}, +"status": { +"description": "[Output Only] Status of the reservation block.", +"enum": [ +"CREATING", +"DELETING", +"INVALID", +"READY" +], +"enumDescriptions": [ +"Resources are being allocated for the reservation block.", +"Reservation block is currently being deleted.", +"", +"Reservation block has allocated all its resources." +], +"type": "string" +}, +"zone": { +"description": "[Output Only] Zone in which the reservation block resides.", +"type": "string" +} +}, +"type": "object" +}, +"ReservationBlocksGetResponse": { +"id": "ReservationBlocksGetResponse", +"properties": { +"resource": { +"$ref": "ReservationBlock" +} +}, +"type": "object" +}, +"ReservationBlocksListResponse": { +"description": "A list of reservation blocks under a single reservation.", +"id": "ReservationBlocksListResponse", +"properties": { +"id": { +"description": "Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of reservation block resources.", +"items": { +"$ref": "ReservationBlock" +}, +"type": "array" +}, +"kind": { +"default": "compute#reservationBlock", +"description": "Type of the resource. Always compute#reservationBlock for a list of reservation blocks.", +"type": "string" +}, +"nextPageToken": { +"description": "This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Server-defined URL for this resource.", +"type": "string" +}, +"warning": { +"description": "Informational warning message.", +"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" +}, "ReservationList": { "id": "ReservationList", "properties": { @@ -87109,7 +87592,8 @@ false "type": "array" }, "cloudArmorConfig": { -"$ref": "SecurityPolicyCloudArmorConfig" +"$ref": "SecurityPolicyCloudArmorConfig", +"deprecated": true }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", @@ -87123,6 +87607,7 @@ false "type": "string" }, "displayName": { +"deprecated": true, "description": "User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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" @@ -87171,6 +87656,7 @@ false "type": "string" }, "ruleTupleCount": { +"deprecated": true, "description": "[Output Only] Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.", "format": "int32", "type": "integer" @@ -87427,6 +87913,7 @@ false "type": "string" }, "displayName": { +"deprecated": true, "description": "[Output Only] The display name of the security policy of the association.", "type": "string" }, @@ -87464,6 +87951,7 @@ false "id": "SecurityPolicyCloudArmorConfig", "properties": { "enableMl": { +"deprecated": true, "description": "If set to true, enables Cloud Armor Machine Learning.", "type": "boolean" } @@ -87678,6 +88166,7 @@ false "type": "string" }, "direction": { +"deprecated": true, "description": "The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.", "enum": [ "EGRESS", @@ -87690,6 +88179,7 @@ false "type": "string" }, "enableLogging": { +"deprecated": true, "description": "Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules. This field may only be specified when the versioned_expr is set to FIREWALL.", "type": "boolean" }, @@ -87756,11 +88246,13 @@ false "type": "string" }, "ruleTupleCount": { +"deprecated": true, "description": "[Output Only] Calculation of the complexity of a single firewall security policy rule.", "format": "int32", "type": "integer" }, "targetResources": { +"deprecated": true, "description": "A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -87768,6 +88260,7 @@ false "type": "array" }, "targetServiceAccounts": { +"deprecated": true, "description": "A list of service accounts indicating the sets of instances that are applied with this rule.", "items": { "type": "string" @@ -87839,6 +88332,7 @@ false "id": "SecurityPolicyRuleMatcherConfig", "properties": { "destIpRanges": { +"deprecated": true, "description": "CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -87846,6 +88340,7 @@ false "type": "array" }, "destPorts": { +"deprecated": true, "description": "Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "$ref": "SecurityPolicyRuleMatcherConfigDestinationPort" @@ -87853,6 +88348,7 @@ false "type": "array" }, "layer4Configs": { +"deprecated": true, "description": "Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "$ref": "SecurityPolicyRuleMatcherConfigLayer4Config" @@ -87873,10 +88369,12 @@ false "id": "SecurityPolicyRuleMatcherConfigDestinationPort", "properties": { "ipProtocol": { +"deprecated": true, "description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.", "type": "string" }, "ports": { +"deprecated": true, "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"]. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -87890,10 +88388,12 @@ false "id": "SecurityPolicyRuleMatcherConfigLayer4Config", "properties": { "ipProtocol": { +"deprecated": true, "description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.", "type": "string" }, "ports": { +"deprecated": true, "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"]. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 54c2e4b0b8c..b5d029b5a12 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -41911,7 +41911,7 @@ } } }, -"revision": "20240820", +"revision": "20240827", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -78755,6 +78755,7 @@ false "type": "string" }, "displayName": { +"deprecated": true, "description": "User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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" @@ -78803,6 +78804,7 @@ false "type": "string" }, "ruleTupleCount": { +"deprecated": true, "description": "[Output Only] Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.", "format": "int32", "type": "integer" @@ -79057,6 +79059,7 @@ false "type": "string" }, "displayName": { +"deprecated": true, "description": "[Output Only] The display name of the security policy of the association.", "type": "string" }, @@ -79287,6 +79290,7 @@ false "type": "string" }, "direction": { +"deprecated": true, "description": "The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.", "enum": [ "EGRESS", @@ -79299,6 +79303,7 @@ false "type": "string" }, "enableLogging": { +"deprecated": true, "description": "Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules. This field may only be specified when the versioned_expr is set to FIREWALL.", "type": "boolean" }, @@ -79346,11 +79351,13 @@ false "type": "string" }, "ruleTupleCount": { +"deprecated": true, "description": "[Output Only] Calculation of the complexity of a single firewall security policy rule.", "format": "int32", "type": "integer" }, "targetResources": { +"deprecated": true, "description": "A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -79358,6 +79365,7 @@ false "type": "array" }, "targetServiceAccounts": { +"deprecated": true, "description": "A list of service accounts indicating the sets of instances that are applied with this rule.", "items": { "type": "string" @@ -79429,6 +79437,7 @@ false "id": "SecurityPolicyRuleMatcherConfig", "properties": { "destIpRanges": { +"deprecated": true, "description": "CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -79436,6 +79445,7 @@ false "type": "array" }, "layer4Configs": { +"deprecated": true, "description": "Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "$ref": "SecurityPolicyRuleMatcherConfigLayer4Config" @@ -79456,10 +79466,12 @@ false "id": "SecurityPolicyRuleMatcherConfigLayer4Config", "properties": { "ipProtocol": { +"deprecated": true, "description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.", "type": "string" }, "ports": { +"deprecated": true, "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"]. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index acdc1b3eadd..4c953d387a3 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -37779,7 +37779,7 @@ } } }, -"revision": "20240820", +"revision": "20240827", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -47969,6 +47969,7 @@ false "SEV_LIVE_MIGRATABLE", "SEV_LIVE_MIGRATABLE_V2", "SEV_SNP_CAPABLE", +"TDX_CAPABLE", "UEFI_COMPATIBLE", "VIRTIO_SCSI_MULTIQUEUE", "WINDOWS" @@ -47985,6 +47986,7 @@ false "", "", "", +"", "" ], "type": "string" @@ -60158,6 +60160,11 @@ false "description": "Metadata defined as annotations on the network endpoint.", "type": "object" }, +"clientDestinationPort": { +"description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.", +"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" @@ -60237,6 +60244,7 @@ false "enum": [ "GCE_VM_IP", "GCE_VM_IP_PORT", +"GCE_VM_IP_PORTMAP", "INTERNET_FQDN_PORT", "INTERNET_IP_PORT", "NON_GCP_PRIVATE_IP_PORT", @@ -60246,6 +60254,7 @@ false "enumDescriptions": [ "The network endpoint is represented by an IP address.", "The network endpoint is represented by IP address and port pair.", +"The network endpoint is represented by an IP, Port and Client Destination Port.", "The network endpoint is represented by fully qualified domain name and port.", "The network endpoint is represented by an internet IP address and port.", "The network endpoint is represented by an IP address and port. The endpoint belongs to a VM or pod running in a customer's on-premises.", diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index 20d9b170894..ea6fd233126 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -2288,6 +2288,46 @@ "resources": { "versions": { "methods": { +"fetchAuthSchema": { +"description": "fetch and return the list of auth config variables required to override the connection backend auth.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/providers/{providersId}/connectors/{connectorsId}/versions/{versionsId}:fetchAuthSchema", +"httpMethod": "GET", +"id": "connectors.projects.locations.providers.connectors.versions.fetchAuthSchema", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Parent resource of the Connector Version, of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/providers/[^/]+/connectors/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. View of the AuthSchema. The default value is BASIC.", +"enum": [ +"AUTH_SCHEMA_VIEW_UNSPECIFIED", +"BASIC", +"JSON_SCHEMA" +], +"enumDescriptions": [ +"Default value.", +"Basic view of the AuthSchema.", +"JSON schema view of the AuthSchema." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:fetchAuthSchema", +"response": { +"$ref": "FetchAuthSchemaResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets details of a single connector version.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/providers/{providersId}/connectors/{connectorsId}/versions/{versionsId}", @@ -2457,7 +2497,7 @@ } } }, -"revision": "20240822", +"revision": "20240904", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2532,7 +2572,8 @@ "OAUTH2_CLIENT_CREDENTIALS", "SSH_PUBLIC_KEY", "OAUTH2_AUTH_CODE_FLOW", -"GOOGLE_AUTHENTICATION" +"GOOGLE_AUTHENTICATION", +"OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED" ], "enumDescriptions": [ "Authentication type not specified.", @@ -2541,7 +2582,8 @@ "Oauth 2.0 Client Credentials Grant Authentication", "SSH Public Key Authentication", "Oauth 2.0 Authorization Code Flow", -"Google authentication" +"Google authentication", +"Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client" ], "type": "string" }, @@ -2549,6 +2591,10 @@ "$ref": "Oauth2AuthCodeFlow", "description": "Oauth2AuthCodeFlow." }, +"oauth2AuthCodeFlowGoogleManaged": { +"$ref": "Oauth2AuthCodeFlowGoogleManaged", +"description": "Oauth2AuthCodeFlowGoogleManaged." +}, "oauth2ClientCredentials": { "$ref": "Oauth2ClientCredentials", "description": "Oauth2ClientCredentials." @@ -2585,7 +2631,8 @@ "OAUTH2_CLIENT_CREDENTIALS", "SSH_PUBLIC_KEY", "OAUTH2_AUTH_CODE_FLOW", -"GOOGLE_AUTHENTICATION" +"GOOGLE_AUTHENTICATION", +"OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED" ], "enumDescriptions": [ "Authentication type not specified.", @@ -2594,7 +2641,8 @@ "Oauth 2.0 Client Credentials Grant Authentication", "SSH Public Key Authentication", "Oauth 2.0 Authorization Code Flow", -"Google authentication" +"Google authentication", +"Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client" ], "type": "string" }, @@ -2620,6 +2668,132 @@ }, "type": "object" }, +"AuthField": { +"description": "AuthField defines a field in an authentication type.", +"id": "AuthField", +"properties": { +"dataType": { +"description": "Data type of the field.", +"type": "string" +}, +"description": { +"description": "Description of the field.", +"type": "string" +}, +"key": { +"description": "Key of the field.", +"type": "string" +} +}, +"type": "object" +}, +"AuthObject": { +"description": "AuthObject defines a JSON schema of an authentication type.", +"id": "AuthObject", +"properties": { +"additionalProperties": { +"description": "Whether the object has additional properties.", +"type": "boolean" +}, +"authKey": { +"description": "Auth key of the object.", +"type": "string" +}, +"authType": { +"description": "Auth type of the object.", +"type": "string" +}, +"description": { +"description": "Description of the object.", +"type": "string" +}, +"isDefault": { +"description": "Whether the object is the default one.", +"type": "boolean" +}, +"properties": { +"additionalProperties": { +"$ref": "AuthProperty" +}, +"description": "Properties of the object.", +"type": "object" +}, +"type": { +"description": "Type of the object.", +"type": "string" +} +}, +"type": "object" +}, +"AuthProperty": { +"description": "AuthProperty defines a property of an authentication type.", +"id": "AuthProperty", +"properties": { +"description": { +"description": "Description of the property.", +"type": "string" +}, +"type": { +"description": "Type of the property.", +"type": "string" +} +}, +"type": "object" +}, +"AuthSchema": { +"description": "AuthSchema defines the schema of an authentication type.", +"id": "AuthSchema", +"properties": { +"authFields": { +"description": "List of AuthFields.", +"items": { +"$ref": "AuthField" +}, +"type": "array" +}, +"authKey": { +"description": "Auth key of the schema.", +"type": "string" +}, +"authType": { +"description": "Auth type of the schema.", +"enum": [ +"AUTH_TYPE_UNSPECIFIED", +"USER_PASSWORD", +"OAUTH2_JWT_BEARER", +"OAUTH2_CLIENT_CREDENTIALS", +"SSH_PUBLIC_KEY", +"OAUTH2_AUTH_CODE_FLOW", +"GOOGLE_AUTHENTICATION", +"OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED" +], +"enumDescriptions": [ +"Authentication type not specified.", +"Username and Password Authentication.", +"JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication", +"Oauth 2.0 Client Credentials Grant Authentication", +"SSH Public Key Authentication", +"Oauth 2.0 Authorization Code Flow", +"Google authentication", +"Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client" +], +"type": "string" +}, +"description": { +"description": "Description of the schema.", +"type": "string" +}, +"displayName": { +"description": "Display name of the schema.", +"type": "string" +}, +"isDefault": { +"description": "Whether the auth schema is the default one.", +"type": "boolean" +} +}, +"type": "object" +}, "AuthorizationCodeLink": { "description": "This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow.", "id": "AuthorizationCodeLink", @@ -2868,6 +3042,10 @@ "$ref": "AuthConfig", "description": "Optional. Configuration for establishing the connection's authentication with an external system." }, +"authOverrideEnabled": { +"description": "Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API.", +"type": "boolean" +}, "billingConfig": { "$ref": "BillingConfig", "description": "Output only. Billing config for the connection.", @@ -3309,6 +3487,10 @@ "description": "Indicate whether connector is being migrated to cloud run deployment model.", "type": "boolean" }, +"migrateTls": { +"description": "Indicate whether connector is being migrated to TLS.", +"type": "boolean" +}, "ratelimitThreshold": { "description": "Max QPS supported by the connector version before throttling of requests.", "format": "int64", @@ -3592,6 +3774,21 @@ "description": "Output only. The name of shared connector deployment.", "readOnly": true, "type": "string" +}, +"tlsMigrationState": { +"description": "Output only. Status of the TLS migration.", +"enum": [ +"TLS_MIGRATION_STATE_UNSPECIFIED", +"TLS_MIGRATION_NOT_STARTED", +"TLS_MIGRATION_COMPLETED" +], +"enumDescriptions": [ +"TLS migration state is not specified.", +"TLS migration is in progress.", +"TLS migration is completed." +], +"readOnly": true, +"type": "string" } }, "type": "object" @@ -4605,6 +4802,24 @@ }, "type": "object" }, +"FetchAuthSchemaResponse": { +"description": "Response message for Connectors.GetAuthSchema.", +"id": "FetchAuthSchemaResponse", +"properties": { +"authSchemas": { +"description": "List of AuthSchemas.", +"items": { +"$ref": "AuthSchema" +}, +"type": "array" +}, +"jsonSchema": { +"$ref": "JsonAuthSchema", +"description": "JSON schema of the AuthSchemas. This is only populated if the view is JSON_SCHEMA. The schema is in draft-07 format." +} +}, +"type": "object" +}, "Field": { "description": "Metadata of an entity field.", "id": "Field", @@ -5185,6 +5400,24 @@ false }, "type": "object" }, +"JsonAuthSchema": { +"description": "JsonAuthSchema defines the JSON schema of all authentication types.", +"id": "JsonAuthSchema", +"properties": { +"$schema": { +"description": "JSON schema of the AuthSchemas.", +"type": "string" +}, +"oneOf": { +"description": "List of AuthObjects.", +"items": { +"$ref": "AuthObject" +}, +"type": "array" +} +}, +"type": "object" +}, "JsonSchema": { "description": "JsonSchema representation of schema metadata", "id": "JsonSchema", @@ -6180,6 +6413,28 @@ false }, "type": "object" }, +"Oauth2AuthCodeFlowGoogleManaged": { +"description": "Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details.", +"id": "Oauth2AuthCodeFlowGoogleManaged", +"properties": { +"authCode": { +"description": "Optional. Authorization code to be exchanged for access and refresh tokens.", +"type": "string" +}, +"redirectUri": { +"description": "Optional. Redirect URI to be provided during the auth code exchange.", +"type": "string" +}, +"scopes": { +"description": "Required. Scopes the connection will request when the user performs the auth code flow.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "Oauth2ClientCredentials": { "description": "Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.", "id": "Oauth2ClientCredentials", diff --git a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json index a8c8ce4ec72..4d9be0b5d2d 100644 --- a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json @@ -512,7 +512,7 @@ } } }, -"revision": "20240702", +"revision": "20240904", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -703,7 +703,7 @@ "type": "object" }, "Critical": { -"description": "Instances in this Channel will receive updates after all instances in `Critical` were updated + 2 days. They also will only be updated outside of their peak hours.", +"description": "Instances in this Channel will receive updates after all instances in `Normal` were updated. They also will only be updated outside of their peak hours.", "id": "Critical", "properties": { "peakHours": { @@ -1034,6 +1034,14 @@ "type": "string" }, "type": "array" +}, +"producerProjectIds": { +"description": "Output only. The CCAIP tenant project ids.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 24ade17c9e0..4ca0a619589 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -14,7 +14,7 @@ "canonicalName": "Container", "description": "Builds and manages container-based applications, powered by the open source Kubernetes technology.", "discoveryVersion": "v1", -"documentationLink": "https://cloud.google.com/container-engine/", +"documentationLink": "https://cloud.google.com/kubernetes-engine/docs/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -2565,7 +2565,7 @@ } } }, -"revision": "20240806", +"revision": "20240814", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3740,6 +3740,10 @@ "$ref": "ClusterTelemetry", "description": "The desired telemetry integration for the cluster." }, +"desiredCompliancePostureConfig": { +"$ref": "CompliancePostureConfig", +"description": "Enable/Disable Compliance Posture features for the cluster." +}, "desiredContainerdConfig": { "$ref": "ContainerdConfig", "description": "The desired containerd config for the cluster." diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json index 53f3e01cf93..2809bd7c57b 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json @@ -409,6 +409,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:getIamPolicy", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.notes.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"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/[^/]+/notes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:getIamPolicy", +"request": { +"$ref": "GetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists notes for the specified project.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes", @@ -483,6 +511,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:setIamPolicy", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.notes.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/[^/]+/notes/[^/]+$", +"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 the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:testIamPermissions", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.notes.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/[^/]+/notes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -641,6 +725,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:getIamPolicy", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.occurrences.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"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/[^/]+/occurrences/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:getIamPolicy", +"request": { +"$ref": "GetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "getNotes": { "description": "Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes", @@ -770,6 +882,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:setIamPolicy", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.occurrences.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/[^/]+/occurrences/[^/]+$", +"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 the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:testIamPermissions", +"httpMethod": "POST", +"id": "containeranalysis.projects.locations.occurrences.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/[^/]+/occurrences/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -1543,7 +1711,7 @@ } } }, -"revision": "20240816", +"revision": "20240830", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/datalineage.v1.json b/googleapiclient/discovery_cache/documents/datalineage.v1.json index e23da12fc2d..90ad2b66410 100644 --- a/googleapiclient/discovery_cache/documents/datalineage.v1.json +++ b/googleapiclient/discovery_cache/documents/datalineage.v1.json @@ -798,7 +798,7 @@ } } }, -"revision": "20240621", +"revision": "20240902", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": { @@ -1060,7 +1060,8 @@ "DATA_FUSION", "COMPOSER", "LOOKER_STUDIO", -"DATAPROC" +"DATAPROC", +"VERTEX_AI" ], "enumDescriptions": [ "Source is Unspecified", @@ -1069,7 +1070,8 @@ "Data Fusion", "Composer", "Looker Studio", -"Dataproc" +"Dataproc", +"Vertex AI" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 4ab24ccfc30..ffee33f68d8 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -2218,7 +2218,7 @@ } } }, -"revision": "20240826", +"revision": "20240902", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -2245,12 +2245,14 @@ "enum": [ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_14", -"POSTGRES_15" +"POSTGRES_15", +"POSTGRES_16" ], "enumDescriptions": [ "This is an unknown database version.", "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/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index aa1d324a443..481cb5ab9fa 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -4453,7 +4453,7 @@ } } }, -"revision": "20240828", +"revision": "20240903", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -7989,7 +7989,7 @@ false "id": "GoogleCloudDialogflowCxV3NluSettings", "properties": { "classificationThreshold": { -"description": "To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.", +"description": "To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent.", "format": "float", "type": "number" }, diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 55787d46afb..d9d9cf1225f 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5185,7 +5185,7 @@ } } }, -"revision": "20240828", +"revision": "20240903", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -11653,7 +11653,7 @@ false "id": "GoogleCloudDialogflowCxV3beta1NluSettings", "properties": { "classificationThreshold": { -"description": "To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.", +"description": "To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent.", "format": "float", "type": "number" }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index f2d77b31e53..fa892da6c8a 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -5986,7 +5986,7 @@ } } }, -"revision": "20240826", +"revision": "20240829", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6181,17 +6181,19 @@ "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", -"CUSTOMER_POLICY_VIOLATION" +"CUSTOMER_POLICY_VIOLATION", +"NON_ANSWER_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", -"The non-answer seeking query ignored case.", +"The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", -"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", +"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent." ], "type": "string" }, @@ -6436,13 +6438,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", -"JAIL_BREAKING_QUERY" +"JAIL_BREAKING_QUERY", +"NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", -"Non-answer-seeking query classification type.", -"Jail-breaking query classification type." +"Non-answer-seeking query classification type, for chit chat.", +"Jail-breaking query classification type.", +"Non-answer-seeking query classification type, for no clear intent." ], "type": "string" }, @@ -6725,13 +6729,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", -"JAIL_BREAKING_QUERY" +"JAIL_BREAKING_QUERY", +"NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", -"Non-answer-seeking query classification type.", -"Jail-breaking query classification type." +"Non-answer-seeking query classification type, for chit chat.", +"Jail-breaking query classification type.", +"Non-answer-seeking query classification type, for no clear intent." ], "type": "string" } @@ -8392,6 +8398,11 @@ "description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "type": "string" }, +"indexStatus": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentIndexStatus", +"description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset.", +"readOnly": true +}, "indexTime": { "description": "Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.", "format": "google-datetime", @@ -8445,6 +8456,25 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentIndexStatus": { +"description": "Index status of the document.", +"id": "GoogleCloudDiscoveryengineV1DocumentIndexStatus", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"indexTime": { +"description": "The time when the document was indexed. If this field is populated, it means the document has been indexed.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DocumentInfo": { "description": "Detailed document information associated with a user event.", "id": "GoogleCloudDiscoveryengineV1DocumentInfo", @@ -10781,18 +10811,20 @@ "LLM_ADDON_NOT_ENABLED", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", -"CUSTOMER_POLICY_VIOLATION" +"CUSTOMER_POLICY_VIOLATION", +"NON_SUMMARY_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", -"The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", +"The non-summary seeking query ignored case. Google skips the summary if the query is chit chat. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", -"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", +"The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`." ], "type": "string" }, @@ -11510,15 +11542,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", -"GOOGLE_GROUPS" +"GOOGLE_CHAT", +"GOOGLE_GROUPS", +"GOOGLE_KEEP" ], "enumDescriptions": [ -"Default value.", -"The data store is used to store content from Google Drive.", -"The data store is used to store content from Gmail.", -"The data store is used to store content from Google Sites.", -"The data store is used to store content from Google Calendar.", -"The data store is used to store content from Google Groups." +"Defaults to an unspecified Workspace type.", +"Workspace Data Store contains Drive data", +"Workspace Data Store contains Mail data", +"Workspace Data Store contains Sites data", +"Workspace Data Store contains Calendar data", +"Workspace Data Store contains Chat data", +"Workspace Data Store contains Groups data", +"Workspace Data Store contains Keep data" ], "type": "string" } @@ -11555,17 +11591,19 @@ "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", -"CUSTOMER_POLICY_VIOLATION" +"CUSTOMER_POLICY_VIOLATION", +"NON_ANSWER_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", -"The non-answer seeking query ignored case.", +"The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", -"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", +"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent." ], "type": "string" }, @@ -11705,13 +11743,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", -"JAIL_BREAKING_QUERY" +"JAIL_BREAKING_QUERY", +"NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", -"Non-answer-seeking query classification type.", -"Jail-breaking query classification type." +"Non-answer-seeking query classification type, for chit chat.", +"Jail-breaking query classification type.", +"Non-answer-seeking query classification type, for no clear intent." ], "type": "string" } @@ -15119,15 +15159,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", -"GOOGLE_GROUPS" +"GOOGLE_CHAT", +"GOOGLE_GROUPS", +"GOOGLE_KEEP" ], "enumDescriptions": [ -"Default value.", -"The data store is used to store content from Google Drive.", -"The data store is used to store content from Gmail.", -"The data store is used to store content from Google Sites.", -"The data store is used to store content from Google Calendar.", -"The data store is used to store content from Google Groups." +"Defaults to an unspecified Workspace type.", +"Workspace Data Store contains Drive data", +"Workspace Data Store contains Mail data", +"Workspace Data Store contains Sites data", +"Workspace Data Store contains Calendar data", +"Workspace Data Store contains Chat data", +"Workspace Data Store contains Groups data", +"Workspace Data Store contains Keep data" ], "type": "string" } @@ -17568,15 +17612,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", -"GOOGLE_GROUPS" +"GOOGLE_CHAT", +"GOOGLE_GROUPS", +"GOOGLE_KEEP" ], "enumDescriptions": [ -"Default value.", -"The data store is used to store content from Google Drive.", -"The data store is used to store content from Gmail.", -"The data store is used to store content from Google Sites.", -"The data store is used to store content from Google Calendar.", -"The data store is used to store content from Google Groups." +"Defaults to an unspecified Workspace type.", +"Workspace Data Store contains Drive data", +"Workspace Data Store contains Mail data", +"Workspace Data Store contains Sites data", +"Workspace Data Store contains Calendar data", +"Workspace Data Store contains Chat data", +"Workspace Data Store contains Groups data", +"Workspace Data Store contains Keep data" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 8f6f941edf4..1a20f833ea9 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -7517,7 +7517,7 @@ } } }, -"revision": "20240826", +"revision": "20240829", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -9293,15 +9293,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", -"GOOGLE_GROUPS" +"GOOGLE_CHAT", +"GOOGLE_GROUPS", +"GOOGLE_KEEP" ], "enumDescriptions": [ -"Default value.", -"The data store is used to store content from Google Drive.", -"The data store is used to store content from Gmail.", -"The data store is used to store content from Google Sites.", -"The data store is used to store content from Google Calendar.", -"The data store is used to store content from Google Groups." +"Defaults to an unspecified Workspace type.", +"Workspace Data Store contains Drive data", +"Workspace Data Store contains Mail data", +"Workspace Data Store contains Sites data", +"Workspace Data Store contains Calendar data", +"Workspace Data Store contains Chat data", +"Workspace Data Store contains Groups data", +"Workspace Data Store contains Keep data" ], "type": "string" } @@ -9369,17 +9373,19 @@ "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", -"CUSTOMER_POLICY_VIOLATION" +"CUSTOMER_POLICY_VIOLATION", +"NON_ANSWER_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", -"The non-answer seeking query ignored case.", +"The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", -"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", +"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent." ], "type": "string" }, @@ -9624,13 +9630,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", -"JAIL_BREAKING_QUERY" +"JAIL_BREAKING_QUERY", +"NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", -"Non-answer-seeking query classification type.", -"Jail-breaking query classification type." +"Non-answer-seeking query classification type, for chit chat.", +"Jail-breaking query classification type.", +"Non-answer-seeking query classification type, for no clear intent." ], "type": "string" }, @@ -9917,13 +9925,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", -"JAIL_BREAKING_QUERY" +"JAIL_BREAKING_QUERY", +"NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", -"Non-answer-seeking query classification type.", -"Jail-breaking query classification type." +"Non-answer-seeking query classification type, for chit chat.", +"Jail-breaking query classification type.", +"Non-answer-seeking query classification type, for no clear intent." ], "type": "string" } @@ -11714,6 +11724,11 @@ "description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "type": "string" }, +"indexStatus": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus", +"description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset.", +"readOnly": true +}, "indexTime": { "description": "Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.", "format": "google-datetime", @@ -11799,6 +11814,25 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus": { +"description": "Index status of the document.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"indexTime": { +"description": "The time when the document was indexed. If this field is populated, it means the document has been indexed.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDocumentInfo": { "description": "Detailed document information associated with a user event.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo", @@ -15906,18 +15940,20 @@ "LLM_ADDON_NOT_ENABLED", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", -"CUSTOMER_POLICY_VIOLATION" +"CUSTOMER_POLICY_VIOLATION", +"NON_SUMMARY_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", -"The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", +"The non-summary seeking query ignored case. Google skips the summary if the query is chit chat. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", -"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", +"The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`." ], "type": "string" }, @@ -16881,15 +16917,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", -"GOOGLE_GROUPS" +"GOOGLE_CHAT", +"GOOGLE_GROUPS", +"GOOGLE_KEEP" ], "enumDescriptions": [ -"Default value.", -"The data store is used to store content from Google Drive.", -"The data store is used to store content from Gmail.", -"The data store is used to store content from Google Sites.", -"The data store is used to store content from Google Calendar.", -"The data store is used to store content from Google Groups." +"Defaults to an unspecified Workspace type.", +"Workspace Data Store contains Drive data", +"Workspace Data Store contains Mail data", +"Workspace Data Store contains Sites data", +"Workspace Data Store contains Calendar data", +"Workspace Data Store contains Chat data", +"Workspace Data Store contains Groups data", +"Workspace Data Store contains Keep data" ], "type": "string" } @@ -19330,15 +19370,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", -"GOOGLE_GROUPS" +"GOOGLE_CHAT", +"GOOGLE_GROUPS", +"GOOGLE_KEEP" ], "enumDescriptions": [ -"Default value.", -"The data store is used to store content from Google Drive.", -"The data store is used to store content from Gmail.", -"The data store is used to store content from Google Sites.", -"The data store is used to store content from Google Calendar.", -"The data store is used to store content from Google Groups." +"Defaults to an unspecified Workspace type.", +"Workspace Data Store contains Drive data", +"Workspace Data Store contains Mail data", +"Workspace Data Store contains Sites data", +"Workspace Data Store contains Calendar data", +"Workspace Data Store contains Chat data", +"Workspace Data Store contains Groups data", +"Workspace Data Store contains Keep data" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 88c166e317a..2a3806224ca 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -6786,7 +6786,7 @@ } } }, -"revision": "20240826", +"revision": "20240829", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -8376,15 +8376,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", -"GOOGLE_GROUPS" +"GOOGLE_CHAT", +"GOOGLE_GROUPS", +"GOOGLE_KEEP" ], "enumDescriptions": [ -"Default value.", -"The data store is used to store content from Google Drive.", -"The data store is used to store content from Gmail.", -"The data store is used to store content from Google Sites.", -"The data store is used to store content from Google Calendar.", -"The data store is used to store content from Google Groups." +"Defaults to an unspecified Workspace type.", +"Workspace Data Store contains Drive data", +"Workspace Data Store contains Mail data", +"Workspace Data Store contains Sites data", +"Workspace Data Store contains Calendar data", +"Workspace Data Store contains Chat data", +"Workspace Data Store contains Groups data", +"Workspace Data Store contains Keep data" ], "type": "string" } @@ -8421,17 +8425,19 @@ "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", -"CUSTOMER_POLICY_VIOLATION" +"CUSTOMER_POLICY_VIOLATION", +"NON_ANSWER_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", -"The non-answer seeking query ignored case.", +"The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", -"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", +"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent." ], "type": "string" }, @@ -8571,13 +8577,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", -"JAIL_BREAKING_QUERY" +"JAIL_BREAKING_QUERY", +"NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", -"Non-answer-seeking query classification type.", -"Jail-breaking query classification type." +"Non-answer-seeking query classification type, for chit chat.", +"Jail-breaking query classification type.", +"Non-answer-seeking query classification type, for no clear intent." ], "type": "string" } @@ -11985,15 +11993,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", -"GOOGLE_GROUPS" +"GOOGLE_CHAT", +"GOOGLE_GROUPS", +"GOOGLE_KEEP" ], "enumDescriptions": [ -"Default value.", -"The data store is used to store content from Google Drive.", -"The data store is used to store content from Gmail.", -"The data store is used to store content from Google Sites.", -"The data store is used to store content from Google Calendar.", -"The data store is used to store content from Google Groups." +"Defaults to an unspecified Workspace type.", +"Workspace Data Store contains Drive data", +"Workspace Data Store contains Mail data", +"Workspace Data Store contains Sites data", +"Workspace Data Store contains Calendar data", +"Workspace Data Store contains Chat data", +"Workspace Data Store contains Groups data", +"Workspace Data Store contains Keep data" ], "type": "string" } @@ -12046,17 +12058,19 @@ "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", -"CUSTOMER_POLICY_VIOLATION" +"CUSTOMER_POLICY_VIOLATION", +"NON_ANSWER_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", -"The non-answer seeking query ignored case.", +"The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", -"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", +"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent." ], "type": "string" }, @@ -12301,13 +12315,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", -"JAIL_BREAKING_QUERY" +"JAIL_BREAKING_QUERY", +"NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", -"Non-answer-seeking query classification type.", -"Jail-breaking query classification type." +"Non-answer-seeking query classification type, for chit chat.", +"Jail-breaking query classification type.", +"Non-answer-seeking query classification type, for no clear intent." ], "type": "string" }, @@ -12590,13 +12606,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", -"JAIL_BREAKING_QUERY" +"JAIL_BREAKING_QUERY", +"NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", -"Non-answer-seeking query classification type.", -"Jail-breaking query classification type." +"Non-answer-seeking query classification type, for chit chat.", +"Jail-breaking query classification type.", +"Non-answer-seeking query classification type, for no clear intent." ], "type": "string" } @@ -14274,6 +14292,11 @@ "description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "type": "string" }, +"indexStatus": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentIndexStatus", +"description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset.", +"readOnly": true +}, "indexTime": { "description": "Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.", "format": "google-datetime", @@ -14327,6 +14350,25 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDocumentIndexStatus": { +"description": "Index status of the document.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentIndexStatus", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"indexTime": { +"description": "The time when the document was indexed. If this field is populated, it means the document has been indexed.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDocumentInfo": { "description": "Detailed document information associated with a user event.", "id": "GoogleCloudDiscoveryengineV1betaDocumentInfo", @@ -17613,18 +17655,20 @@ "LLM_ADDON_NOT_ENABLED", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", -"CUSTOMER_POLICY_VIOLATION" +"CUSTOMER_POLICY_VIOLATION", +"NON_SUMMARY_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", -"The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", +"The non-summary seeking query ignored case. Google skips the summary if the query is chit chat. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", -"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", +"The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`." ], "type": "string" }, @@ -18527,15 +18571,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", -"GOOGLE_GROUPS" +"GOOGLE_CHAT", +"GOOGLE_GROUPS", +"GOOGLE_KEEP" ], "enumDescriptions": [ -"Default value.", -"The data store is used to store content from Google Drive.", -"The data store is used to store content from Gmail.", -"The data store is used to store content from Google Sites.", -"The data store is used to store content from Google Calendar.", -"The data store is used to store content from Google Groups." +"Defaults to an unspecified Workspace type.", +"Workspace Data Store contains Drive data", +"Workspace Data Store contains Mail data", +"Workspace Data Store contains Sites data", +"Workspace Data Store contains Calendar data", +"Workspace Data Store contains Chat data", +"Workspace Data Store contains Groups data", +"Workspace Data Store contains Keep data" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index e0466d8a1e7..28bd5be9033 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5015,7 +5015,7 @@ } } }, -"revision": "20240825", +"revision": "20240901", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -6525,6 +6525,14 @@ "$ref": "GooglePrivacyDlpV2PubSubNotification", "description": "Publish a message into the Pub/Sub topic." }, +"publishToChronicle": { +"$ref": "GooglePrivacyDlpV2PublishToChronicle", +"description": "Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download)." +}, +"publishToScc": { +"$ref": "GooglePrivacyDlpV2PublishToSecurityCommandCenter", +"description": "Publishes findings to SCC for each data profile." +}, "tagResources": { "$ref": "GooglePrivacyDlpV2TagResources", "description": "Tags the profiled resources with the specified tag values." @@ -10405,6 +10413,12 @@ "properties": {}, "type": "object" }, +"GooglePrivacyDlpV2PublishToChronicle": { +"description": "Message expressing intention to publish to Google Security Operations.", +"id": "GooglePrivacyDlpV2PublishToChronicle", +"properties": {}, +"type": "object" +}, "GooglePrivacyDlpV2PublishToPubSub": { "description": "Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk", "id": "GooglePrivacyDlpV2PublishToPubSub", @@ -10416,6 +10430,12 @@ }, "type": "object" }, +"GooglePrivacyDlpV2PublishToSecurityCommandCenter": { +"description": "If set, a summary finding will be created/updated in SCC for each profile.", +"id": "GooglePrivacyDlpV2PublishToSecurityCommandCenter", +"properties": {}, +"type": "object" +}, "GooglePrivacyDlpV2PublishToStackdriver": { "description": "Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'.", "id": "GooglePrivacyDlpV2PublishToStackdriver", diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 6cef24cc95b..a9c353e80f5 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -1145,6 +1145,42 @@ "https://www.googleapis.com/auth/drive.file" ] }, +"download": { +"description": "Downloads content of a file. Operations are valid for 24 hours from the time of creation.", +"flatPath": "files/{fileId}/download", +"httpMethod": "POST", +"id": "drive.files.download", +"parameterOrder": [ +"fileId" +], +"parameters": { +"fileId": { +"description": "Required. The ID of the file to download.", +"location": "path", +"required": true, +"type": "string" +}, +"mimeType": { +"description": "Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. See [Export MIME types for Google Workspace documents](/drive/api/guides/ref-export-formats) for the list of supported MIME types. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.", +"location": "query", +"type": "string" +}, +"revisionId": { +"description": "Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.", +"location": "query", +"type": "string" +} +}, +"path": "files/{fileId}/download", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/drive", +"https://www.googleapis.com/auth/drive.file", +"https://www.googleapis.com/auth/drive.readonly" +] +}, "emptyTrash": { "description": "Permanently deletes all of the user's trashed files.", "flatPath": "files/trash", @@ -1668,6 +1704,111 @@ } } }, +"operation": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "operation/{name}:cancel", +"httpMethod": "POST", +"id": "drive.operation.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "operation/{name}:cancel" +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "operation/{name}", +"httpMethod": "DELETE", +"id": "drive.operation.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "operation/{name}" +} +} +}, +"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": "operations/{name}", +"httpMethod": "GET", +"id": "drive.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "operations/{name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/drive", +"https://www.googleapis.com/auth/drive.file", +"https://www.googleapis.com/auth/drive.meet.readonly", +"https://www.googleapis.com/auth/drive.readonly" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "operations", +"httpMethod": "GET", +"id": "drive.operations.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "query", +"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": "operations", +"response": { +"$ref": "ListOperationsResponse" +} +} +} +}, "permissions": { "methods": { "create": { @@ -2523,7 +2664,7 @@ } } }, -"revision": "20240809", +"revision": "20240903", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -4207,6 +4348,24 @@ }, "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" +}, "ModifyLabelsRequest": { "description": "A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.", "id": "ModifyLabelsRequest", @@ -4243,6 +4402,41 @@ }, "type": "object" }, +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", +"properties": { +"done": { +"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"type": "boolean" +}, +"error": { +"$ref": "Status", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", +"type": "object" +}, +"name": { +"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", +"type": "object" +} +}, +"type": "object" +}, "Permission": { "description": "A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.", "id": "Permission", @@ -4575,6 +4769,33 @@ }, "type": "object" }, +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, "TeamDrive": { "description": "Deprecated: use the drive collection instead.", "id": "TeamDrive", diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json index 3c6b43baaad..7ee836e4e5b 100644 --- a/googleapiclient/discovery_cache/documents/file.v1.json +++ b/googleapiclient/discovery_cache/documents/file.v1.json @@ -902,7 +902,7 @@ } } }, -"revision": "20240821", +"revision": "20240905", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1140,6 +1140,18 @@ }, "type": "object" }, +"FixedIOPS": { +"description": "Fixed IOPS (input/output operations per second) 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", @@ -1415,10 +1427,27 @@ }, "type": "object" }, +"IOPSPerTB": { +"description": "IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB).", +"id": "IOPSPerTB", +"properties": { +"maxReadIopsPerTb": { +"description": "Required. Maximum read IOPS per TiB.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "Instance": { "description": "A Filestore instance.", "id": "Instance", "properties": { +"configurablePerformanceEnabled": { +"description": "Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field.", +"readOnly": true, +"type": "boolean" +}, "createTime": { "description": "Output only. The time when the instance was created.", "format": "google-datetime", @@ -1471,6 +1500,15 @@ }, "type": "array" }, +"performanceConfig": { +"$ref": "PerformanceConfig", +"description": "Optional. Used to configure performance." +}, +"performanceLimits": { +"$ref": "PerformanceLimits", +"description": "Output only. Used for getting performance limits.", +"readOnly": true +}, "protocol": { "description": "Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`.", "enum": [ @@ -1975,6 +2013,52 @@ }, "type": "object" }, +"PerformanceConfig": { +"description": "Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively).", +"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." +}, +"iopsPerTb": { +"$ref": "IOPSPerTB", +"description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." +} +}, +"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" +}, +"maxReadThroughputBps": { +"description": "Output only. The max read throughput in bytes per second.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"maxWriteIops": { +"description": "Output only. The max write IOPS.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"maxWriteThroughputBps": { +"description": "Output only. The max write throughput in bytes per second.", +"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 97d9a0dbc9c..b194592b440 100644 --- a/googleapiclient/discovery_cache/documents/file.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json @@ -502,7 +502,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * \"description\" * \"directory_services\" * \"file_shares\" * \"labels\"", +"description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * \"description\" * \"directory_services\" * \"file_shares\" * \"labels\" * \"performance_config\" * \"deletion_protection_enabled\" * \"deletion_protection_reason\"", "format": "google-fieldmask", "location": "query", "type": "string" @@ -520,7 +520,7 @@ ] }, "promoteReplica": { -"description": "Promote an standby instance (replica).", +"description": "Promote the standby instance (replica).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:promoteReplica", "httpMethod": "POST", "id": "file.projects.locations.instances.promoteReplica", @@ -1069,7 +1069,7 @@ } } }, -"revision": "20240716", +"revision": "20240905", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1205,7 +1205,7 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"description": "Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", "type": "object" } }, @@ -1318,6 +1318,18 @@ }, "type": "object" }, +"FixedIOPS": { +"description": "Fixed IOPS (input/output operations per second) 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", @@ -1593,6 +1605,18 @@ }, "type": "object" }, +"IOPSPerTB": { +"description": "IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB).", +"id": "IOPSPerTB", +"properties": { +"maxReadIopsPerTb": { +"description": "Required. Maximum read IOPS per TiB.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "Instance": { "description": "A Filestore instance.", "id": "Instance", @@ -1608,12 +1632,25 @@ "readOnly": true, "type": "string" }, +"configurablePerformanceEnabled": { +"description": "Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field.", +"readOnly": true, +"type": "boolean" +}, "createTime": { "description": "Output only. The time when the instance was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, +"deletionProtectionEnabled": { +"description": "Optional. Indicates whether the instance is protected against deletion.", +"type": "boolean" +}, +"deletionProtectionReason": { +"description": "Optional. The reason for enabling deletion protection.", +"type": "string" +}, "description": { "description": "The description of the instance (2048 characters or less).", "type": "string" @@ -1671,6 +1708,15 @@ }, "type": "array" }, +"performanceConfig": { +"$ref": "PerformanceConfig", +"description": "Optional. Used to configure performance." +}, +"performanceLimits": { +"$ref": "PerformanceLimits", +"description": "Output only. Used for getting performance limits.", +"readOnly": true +}, "protocol": { "description": "Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`.", "enum": [ @@ -1687,7 +1733,7 @@ }, "replication": { "$ref": "Replication", -"description": "Optional. Replicaition configuration." +"description": "Optional. Replication configuration." }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", @@ -1757,7 +1803,7 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"description": "Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", "type": "object" }, "tier": { @@ -2018,11 +2064,11 @@ "type": "object" }, "ManagedActiveDirectoryConfig": { -"description": "ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Active Directory.", +"description": "ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Service for Microsoft Active Directory (Managed Microsoft AD).", "id": "ManagedActiveDirectoryConfig", "properties": { "computer": { -"description": "Required. The computer name is used as a prefix to the mount remote target. Example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `.", +"description": "Required. The computer name is used as a prefix in the command to mount the remote target. For example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `.", "type": "string" }, "domain": { @@ -2236,6 +2282,52 @@ }, "type": "object" }, +"PerformanceConfig": { +"description": "Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively).", +"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." +}, +"iopsPerTb": { +"$ref": "IOPSPerTB", +"description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." +} +}, +"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" +}, +"maxReadThroughputBps": { +"description": "Output only. The max read throughput in bytes per second.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"maxWriteIops": { +"description": "Output only. The max write IOPS.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"maxWriteThroughputBps": { +"description": "Output only. The max write throughput in bytes per second.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "PromoteReplicaRequest": { "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).", "id": "PromoteReplicaRequest", @@ -2296,7 +2388,7 @@ "id": "Replication", "properties": { "replicas": { -"description": "Replicas configuration on the instance. For now, only a single replica config is supported.", +"description": "Replication configuration for the replica instance associated with this instance. Only a single replica is supported.", "items": { "$ref": "ReplicaConfig" }, @@ -2311,8 +2403,8 @@ ], "enumDescriptions": [ "Role not set.", -"The instance is a Active replication member, functions as the replication source instance.", -"The instance is a Standby replication member, functions as the replication destination instance." +"The instance is the `ACTIVE` replication member, functions as the replication source instance.", +"The instance is the `STANDBY` replication member, functions as the replication destination instance." ], "type": "string" } @@ -2509,7 +2601,7 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"description": "Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", "type": "object" } }, diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 076d58d8773..6418e622def 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20240821", +"revision": "20240902", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -1096,14 +1096,16 @@ "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", -"BLOCK_NONE" +"BLOCK_NONE", +"OFF" ], "enumDescriptions": [ "Unspecified harm block threshold.", "Block low threshold and above (i.e. block more).", "Block medium threshold and above.", "Block only high threshold (i.e. block less).", -"Block none." +"Block none.", +"Turn off the safety filter." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 3f8e03fdbfe..01e2ccc6927 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -2111,7 +2111,7 @@ } } }, -"revision": "20240825", +"revision": "20240902", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -4164,6 +4164,22 @@ }, "type": "object" }, +"IdentityServiceDiagnosticInterface": { +"description": "Configuration options for the AIS diagnostic interface.", +"id": "IdentityServiceDiagnosticInterface", +"properties": { +"enabled": { +"description": "Determines whether to enable the diagnostic interface.", +"type": "boolean" +}, +"expirationTime": { +"description": "Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "IdentityServiceGoogleConfig": { "description": "Configuration for the Google Plugin Auth flow.", "id": "IdentityServiceGoogleConfig", @@ -4198,8 +4214,12 @@ "description": "Holds non-protocol-related configuration options.", "id": "IdentityServiceIdentityServiceOptions", "properties": { +"diagnosticInterface": { +"$ref": "IdentityServiceDiagnosticInterface", +"description": "Configuration options for the AIS diagnostic interface." +}, "sessionDuration": { -"description": "Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service.", +"description": "Determines the lifespan of STS tokens issued by Anthos Identity Service.", "format": "google-duration", "type": "string" } @@ -6082,6 +6102,7 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", +"CLUSTER_HAS_ZERO_NODES", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", "VPCSC_GA_SUPPORTED", "CONFIG_APPLY_INTERNAL_ERROR", @@ -6112,6 +6133,7 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", +"Cluster has zero node code", "Multiple control planes unsupported error code", "VPC-SC GA is supported for this control plane.", "Configuration (Istio/k8s resources) failed to apply due to internal error.", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 3b79e40b57b..d549054490d 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2185,7 +2185,7 @@ } } }, -"revision": "20240825", +"revision": "20240902", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -4477,6 +4477,22 @@ }, "type": "object" }, +"IdentityServiceDiagnosticInterface": { +"description": "Configuration options for the AIS diagnostic interface.", +"id": "IdentityServiceDiagnosticInterface", +"properties": { +"enabled": { +"description": "Determines whether to enable the diagnostic interface.", +"type": "boolean" +}, +"expirationTime": { +"description": "Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "IdentityServiceGoogleConfig": { "description": "Configuration for the Google Plugin Auth flow.", "id": "IdentityServiceGoogleConfig", @@ -4511,8 +4527,12 @@ "description": "Holds non-protocol-related configuration options.", "id": "IdentityServiceIdentityServiceOptions", "properties": { +"diagnosticInterface": { +"$ref": "IdentityServiceDiagnosticInterface", +"description": "Configuration options for the AIS diagnostic interface." +}, "sessionDuration": { -"description": "Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service.", +"description": "Determines the lifespan of STS tokens issued by Anthos Identity Service.", "format": "google-duration", "type": "string" } @@ -6606,6 +6626,7 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", +"CLUSTER_HAS_ZERO_NODES", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", "VPCSC_GA_SUPPORTED", "CONFIG_APPLY_INTERNAL_ERROR", @@ -6636,6 +6657,7 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", +"Cluster has zero node code", "Multiple control planes unsupported error code", "VPC-SC GA is supported for this control plane.", "Configuration (Istio/k8s resources) failed to apply due to internal error.", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index d893b13d60c..01aa8cc91a2 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2111,7 +2111,7 @@ } } }, -"revision": "20240825", +"revision": "20240902", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -4258,6 +4258,22 @@ }, "type": "object" }, +"IdentityServiceDiagnosticInterface": { +"description": "Configuration options for the AIS diagnostic interface.", +"id": "IdentityServiceDiagnosticInterface", +"properties": { +"enabled": { +"description": "Determines whether to enable the diagnostic interface.", +"type": "boolean" +}, +"expirationTime": { +"description": "Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "IdentityServiceGoogleConfig": { "description": "Configuration for the Google Plugin Auth flow.", "id": "IdentityServiceGoogleConfig", @@ -4292,8 +4308,12 @@ "description": "Holds non-protocol-related configuration options.", "id": "IdentityServiceIdentityServiceOptions", "properties": { +"diagnosticInterface": { +"$ref": "IdentityServiceDiagnosticInterface", +"description": "Configuration options for the AIS diagnostic interface." +}, "sessionDuration": { -"description": "Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service.", +"description": "Determines the lifespan of STS tokens issued by Anthos Identity Service.", "format": "google-duration", "type": "string" } @@ -6245,6 +6265,7 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", +"CLUSTER_HAS_ZERO_NODES", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", "VPCSC_GA_SUPPORTED", "CONFIG_APPLY_INTERNAL_ERROR", @@ -6275,6 +6296,7 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", +"Cluster has zero node code", "Multiple control planes unsupported error code", "VPC-SC GA is supported for this control plane.", "Configuration (Istio/k8s resources) failed to apply due to internal error.", diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index 3ad5280ab34..f2cff407a36 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -3341,6 +3341,116 @@ "resources": { "fhir": { "methods": { +"Binary-create": { +"description": "Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary", +"httpMethod": "POST", +"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the FHIR store this resource belongs to.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/fhir/Binary", +"request": { +"$ref": "HttpBody" +}, +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"Binary-read": { +"description": "Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-read", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Binary resource to retrieve.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"Binary-update": { +"description": "Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}", +"httpMethod": "PUT", +"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-update", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the resource to update.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "HttpBody" +}, +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"Binary-vread": { +"description": "Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}/_history/{_historyId}", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-vread", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Binary resource version to retrieve.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+/_history/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "Patient-everything": { "description": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything", @@ -4673,7 +4783,7 @@ } } }, -"revision": "20240819", +"revision": "20240822", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 4fb8a581bc0..fe9d7d789dc 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -4078,6 +4078,116 @@ "resources": { "fhir": { "methods": { +"Binary-create": { +"description": "Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary", +"httpMethod": "POST", +"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the FHIR store this resource belongs to.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/fhir/Binary", +"request": { +"$ref": "HttpBody" +}, +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"Binary-read": { +"description": "Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-read", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Binary resource to retrieve.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"Binary-update": { +"description": "Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}", +"httpMethod": "PUT", +"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-update", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the resource to update.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "HttpBody" +}, +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"Binary-vread": { +"description": "Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}/_history/{_historyId}", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-vread", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Binary resource version to retrieve.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+/_history/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "ConceptMap-search-translate": { "description": "Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/ConceptMap/$translate", @@ -5748,7 +5858,7 @@ } } }, -"revision": "20240819", +"revision": "20240822", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { diff --git a/googleapiclient/discovery_cache/documents/integrations.v1.json b/googleapiclient/discovery_cache/documents/integrations.v1.json index 87f6f3080cc..5e7d373d6dd 100644 --- a/googleapiclient/discovery_cache/documents/integrations.v1.json +++ b/googleapiclient/discovery_cache/documents/integrations.v1.json @@ -4084,7 +4084,7 @@ } } }, -"revision": "20240825", +"revision": "20240902", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -8712,7 +8712,8 @@ false "OAUTH2_CLIENT_CREDENTIALS", "SSH_PUBLIC_KEY", "OAUTH2_AUTH_CODE_FLOW", -"GOOGLE_AUTHENTICATION" +"GOOGLE_AUTHENTICATION", +"OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED" ], "enumDescriptions": [ "Authentication type not specified.", @@ -8721,7 +8722,8 @@ false "Oauth 2.0 Client Credentials Grant Authentication", "SSH Public Key Authentication", "Oauth 2.0 Authorization Code Flow", -"Google authentication" +"Google authentication", +"Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client" ], "type": "string" }, @@ -8729,6 +8731,10 @@ false "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow", "description": "Oauth2AuthCodeFlow." }, +"oauth2AuthCodeFlowGoogleManaged": { +"$ref": "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged", +"description": "Oauth2AuthCodeFlowGoogleManaged." +}, "oauth2ClientCredentials": { "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials", "description": "Oauth2ClientCredentials." @@ -8790,6 +8796,28 @@ false }, "type": "object" }, +"GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged": { +"description": "Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details.", +"id": "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged", +"properties": { +"authCode": { +"description": "Optional. Authorization code to be exchanged for access and refresh tokens.", +"type": "string" +}, +"redirectUri": { +"description": "Optional. Redirect URI to be provided during the auth code exchange.", +"type": "string" +}, +"scopes": { +"description": "Required. Scopes the connection will request when the user performs the auth code flow.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials": { "description": "Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.", "id": "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials", @@ -9110,6 +9138,21 @@ false "description": "Optional. Suspended indicates if a user has suspended a connection or not.", "type": "boolean" }, +"tlsMigrationState": { +"description": "Output only. Status of the TLS migration.", +"enum": [ +"TLS_MIGRATION_STATE_UNSPECIFIED", +"TLS_MIGRATION_NOT_STARTED", +"TLS_MIGRATION_COMPLETED" +], +"enumDescriptions": [ +"TLS migration state is not specified.", +"TLS migration is in progress.", +"TLS migration is completed." +], +"readOnly": true, +"type": "string" +}, "tlsServiceDirectory": { "description": "Output only. The name of the Service Directory service with TLS.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index 9d56da63e7b..8c521570c30 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -8424,7 +8424,7 @@ } } }, -"revision": "20240726", +"revision": "20240830", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AuditConfig": { @@ -10209,6 +10209,25 @@ "description": "The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.", "format": "google-duration", "type": "string" +}, +"timeSeriesResourceHierarchyLevel": { +"description": "The scope of the timeseries data of the metric.", +"items": { +"enum": [ +"TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED", +"PROJECT", +"ORGANIZATION", +"FOLDER" +], +"enumDescriptions": [ +"Do not use this default value.", +"Scopes a metric to a project.", +"Scopes a metric to an organization.", +"Scopes a metric to a folder." +], +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 0fb1b94d405..5f2edc185c2 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -1354,7 +1354,7 @@ } } }, -"revision": "20240827", +"revision": "20240830", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AcceptTermsOfService": { @@ -2997,7 +2997,7 @@ false "type": "object" }, "ShippingSettings": { -"description": "The merchant account's [shipping setting]((https://support.google.com/merchants/answer/6069284).", +"description": "The merchant account's [shipping setting](https://support.google.com/merchants/answer/6069284).", "id": "ShippingSettings", "properties": { "etag": { diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json index 479abb2f533..f420c7c5335 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json @@ -2309,7 +2309,7 @@ } } }, -"revision": "20240822", +"revision": "20240906", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2850,12 +2850,14 @@ "id": "ComputeEngineShapeDescriptor", "properties": { "logicalCoreCount": { -"description": "Number of logical cores.", +"description": "Output only. Number of logical cores.", "format": "int32", +"readOnly": true, "type": "integer" }, "machineType": { -"description": "Compute Engine machine type.", +"description": "Output only. Compute Engine machine type.", +"readOnly": true, "type": "string" }, "memoryMb": { @@ -2869,14 +2871,16 @@ "type": "integer" }, "series": { -"description": "Compute Engine machine series.", +"description": "Output only. Compute Engine machine series.", +"readOnly": true, "type": "string" }, "storage": { -"description": "Compute Engine storage. Never empty.", +"description": "Output only. Compute Engine storage. Never empty.", "items": { "$ref": "ComputeStorageDescriptor" }, +"readOnly": true, "type": "array" } }, @@ -2887,12 +2891,13 @@ "id": "ComputeStorageDescriptor", "properties": { "sizeGb": { -"description": "Disk size in GiB.", +"description": "Output only. Disk size in GiB.", "format": "int32", +"readOnly": true, "type": "integer" }, "type": { -"description": "Disk type backing the storage.", +"description": "Output only. Disk type backing the storage.", "enum": [ "PERSISTENT_DISK_TYPE_UNSPECIFIED", "PERSISTENT_DISK_TYPE_STANDARD", @@ -2905,6 +2910,7 @@ "Balanced Persistent Disk.", "SSD Persistent Disk." ], +"readOnly": true, "type": "string" } }, @@ -3377,7 +3383,7 @@ "id": "FitDescriptor", "properties": { "fitLevel": { -"description": "Fit level.", +"description": "Output only. Fit level.", "enum": [ "FIT_LEVEL_UNSPECIFIED", "FIT", @@ -3390,6 +3396,7 @@ "No Fit.", "Fit with effort." ], +"readOnly": true, "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index 8dd5aa6a2fa..7e705c46ac1 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2548,7 +2548,7 @@ } } }, -"revision": "20240822", +"revision": "20240906", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2828,8 +2828,7 @@ }, "performanceData": { "$ref": "AssetPerformanceData", -"description": "Output only. Performance data for the asset.", -"readOnly": true +"description": "Performance data for the asset." }, "sources": { "description": "Output only. The list of sources contributing to the asset.", @@ -2969,6 +2968,10 @@ "readOnly": true, "type": "string" }, +"inventory": { +"$ref": "AssetsExportJobInventory", +"description": "Export asset inventory details." +}, "labels": { "additionalProperties": { "type": "string" @@ -2985,6 +2988,10 @@ "$ref": "AssetsExportJobNetworkDependencies", "description": "Export data regarding asset network dependencies." }, +"performanceData": { +"$ref": "AssetsExportJobPerformanceData", +"description": "Export asset with performance data." +}, "recentExecutions": { "description": "Output only. Recent non expired executions of the job.", "items": { @@ -2993,6 +3000,10 @@ "readOnly": true, "type": "array" }, +"showHidden": { +"description": "Optional. When this value is set to 'true' the response will include all assets, including those that are hidden.", +"type": "boolean" +}, "signedUriDestination": { "$ref": "SignedUriDestination", "description": "Export to Cloud Storage files downloadable using signed URIs." @@ -3027,6 +3038,12 @@ "readOnly": true, "type": "string" }, +"requestedAssetCount": { +"description": "Output only. Number of assets requested for export after resolving the requested filters.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "result": { "$ref": "AssetsExportJobExecutionResult", "description": "Output only. Result of the export execution.", @@ -3050,6 +3067,11 @@ "description": "Output only. Error encountered during export.", "readOnly": true }, +"outputFiles": { +"$ref": "OutputFileList", +"description": "Output only. List of output files.", +"readOnly": true +}, "signedUris": { "$ref": "SignedUris", "description": "Output only. Signed URLs for downloading export artifacts.", @@ -3069,6 +3091,12 @@ }, "type": "object" }, +"AssetsExportJobInventory": { +"description": "Configuration for asset inventory details exports.", +"id": "AssetsExportJobInventory", +"properties": {}, +"type": "object" +}, "AssetsExportJobNetworkDependencies": { "description": "Configuration for network dependencies exports.", "id": "AssetsExportJobNetworkDependencies", @@ -3081,6 +3109,18 @@ }, "type": "object" }, +"AssetsExportJobPerformanceData": { +"description": "Configuration for performance data exports.", +"id": "AssetsExportJobPerformanceData", +"properties": { +"maxDays": { +"description": "Optional. When this value is set to a positive integer, performance data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. The maximum value is 420; values above 420 will be coerced to 420. If unset (0 value) a default value of 40 will be used.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "AwsEc2PlatformDetails": { "description": "AWS EC2 specific details.", "id": "AwsEc2PlatformDetails", @@ -3228,7 +3268,7 @@ }, "cloudSqlForPostgresqlShape": { "$ref": "CloudSqlForPostgreSqlShape", -"description": "Cloud SQL for Postgres database shape." +"description": "Cloud SQL for PostgreSQL database shape." }, "cloudSqlShape": { "$ref": "CloudSqlForSqlServerShape", @@ -3653,7 +3693,7 @@ "type": "integer" }, "type": { -"description": "Disk type backing the storage.", +"description": "Output only. Disk type backing the storage.", "enum": [ "PERSISTENT_DISK_TYPE_UNSPECIFIED", "PERSISTENT_DISK_TYPE_STANDARD", @@ -3666,6 +3706,7 @@ "Balanced Persistent Disk.", "SSD Persistent Disk." ], +"readOnly": true, "type": "string" } }, @@ -3683,6 +3724,30 @@ }, "type": "object" }, +"CsvOutputFile": { +"description": "Contains a single output file of type CSV.", +"id": "CsvOutputFile", +"properties": { +"columnsCount": { +"description": "Output only. Number of columns in the file.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"rowCount": { +"description": "Output only. Number of rows in the file.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"signedUri": { +"$ref": "SignedUri", +"description": "Output only. Signed URI destination.", +"readOnly": true +} +}, +"type": "object" +}, "DailyResourceUsageAggregation": { "description": "Usage data aggregation for a single day.", "id": "DailyResourceUsageAggregation", @@ -4153,7 +4218,7 @@ "id": "DatabasePreferencesCloudSqlCommonBackup", "properties": { "backupMode": { -"description": "Optional. Mode of automated backups.", +"description": "Optional. Automated backup mode.", "enum": [ "BACKUP_MODE_UNSPECIFIED", "BACKUP_MODE_DISABLED", @@ -4695,7 +4760,7 @@ "id": "FitDescriptor", "properties": { "fitLevel": { -"description": "Fit level.", +"description": "Output only. Fit level.", "enum": [ "FIT_LEVEL_UNSPECIFIED", "FIT", @@ -4708,6 +4773,7 @@ "No Fit.", "Fit with effort." ], +"readOnly": true, "type": "string" } }, @@ -4926,7 +4992,8 @@ false }, "hosts": { "$ref": "HostsEntryList", -"description": "Hosts file (/etc/hosts)." +"description": "Output only. Hosts file (/etc/hosts).", +"readOnly": true }, "issue": { "description": "OS issue (typically /etc/issue in Linux).", @@ -5068,10 +5135,11 @@ false "id": "HostsEntryList", "properties": { "entries": { -"description": "Hosts entries.", +"description": "Output only. Hosts entries.", "items": { "$ref": "HostsEntry" }, +"readOnly": true, "type": "array" } }, @@ -6496,6 +6564,38 @@ false }, "type": "object" }, +"OutputFile": { +"description": "Contains a single output file.", +"id": "OutputFile", +"properties": { +"csvOutputFile": { +"$ref": "CsvOutputFile", +"description": "Output only. CSV output file.", +"readOnly": true +}, +"fileSizeBytes": { +"description": "Output only. File size in bytes.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"OutputFileList": { +"description": "Contains a list of output files.", +"id": "OutputFileList", +"properties": { +"entries": { +"description": "List of output files.", +"items": { +"$ref": "OutputFile" +}, +"type": "array" +} +}, +"type": "object" +}, "PayloadFile": { "description": "Payload file for inline import job payload.", "id": "PayloadFile", diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index 3ced827d911..50b85409e38 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -753,7 +753,7 @@ } } }, -"revision": "20240721", +"revision": "20240829", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1022,10 +1022,37 @@ "description": "The persistent settings for a table's columns.", "id": "ColumnSettings", "properties": { +"alignment": { +"description": "Optional. Whether the column should be left / middle / right aligned", +"enum": [ +"CELL_ALIGNMENT_UNSPECIFIED", +"LEFT", +"CENTER", +"RIGHT" +], +"enumDescriptions": [ +"No horizontal alignment specified; fall back to the default behavior. Label values are left aligned. Numeric values are right aligned.", +"Left-align", +"Center-align", +"Right-align" +], +"type": "string" +}, "column": { "description": "Required. The id of the column.", "type": "string" }, +"displayName": { +"description": "Optional. Display name of the column", +"type": "string" +}, +"thresholds": { +"description": "Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value.", +"items": { +"$ref": "Threshold" +}, +"type": "array" +}, "visible": { "description": "Required. Whether the column should be visible on page load.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json index 1f5953007f0..eb12abcd802 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -2114,7 +2114,7 @@ }, "query": { "deprecated": true, -"description": "Queries time series using Monitoring Query Language.", +"description": "Queries time series by using Monitoring Query Language (MQL). We recommend using PromQL instead of MQL. For more information about the status of MQL, see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql).", "flatPath": "v3/projects/{projectsId}/timeSeries:query", "httpMethod": "POST", "id": "monitoring.projects.timeSeries.query", @@ -2715,7 +2715,7 @@ } } }, -"revision": "20240818", +"revision": "20240829", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -4621,6 +4621,25 @@ "description": "The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.", "format": "google-duration", "type": "string" +}, +"timeSeriesResourceHierarchyLevel": { +"description": "The scope of the timeseries data of the metric.", +"items": { +"enum": [ +"TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED", +"PROJECT", +"ORGANIZATION", +"FOLDER" +], +"enumDescriptions": [ +"Do not use this default value.", +"Scopes a metric to a project.", +"Scopes a metric to an organization.", +"Scopes a metric to a folder." +], +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -5197,7 +5216,7 @@ }, "QueryTimeSeriesRequest": { "deprecated": true, -"description": "The QueryTimeSeries request.", +"description": "The QueryTimeSeries request. For information about the status of Monitoring Query Language (MQL), see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql).", "id": "QueryTimeSeriesRequest", "properties": { "pageSize": { @@ -5218,7 +5237,7 @@ }, "QueryTimeSeriesResponse": { "deprecated": true, -"description": "The QueryTimeSeries response.", +"description": "The QueryTimeSeries response. For information about the status of Monitoring Query Language (MQL), see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql).", "id": "QueryTimeSeriesResponse", "properties": { "nextPageToken": { diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json index 85e36767481..93beec144ad 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json @@ -3253,7 +3253,7 @@ } } }, -"revision": "20240803", +"revision": "20240828", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -3678,14 +3678,16 @@ "CREATING", "ACTIVE", "DELETING", -"INACTIVE" +"INACTIVE", +"ORPHAN" ], "enumDescriptions": [ "Not set.", "Being created.", "Active and ready for traffic.", "Being deleted.", -"Down or in an error state." +"Down or in an error state.", +"The GCP project that housed the association has been deleted." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index 0500603fd4f..b8fab254a80 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -2740,122 +2740,181 @@ } } }, -"operations": { +"mirroringDeploymentGroups": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"create": { +"description": "Creates a new MirroringDeploymentGroup in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups", "httpMethod": "POST", -"id": "networksecurity.projects.locations.operations.cancel", +"id": "networksecurity.projects.locations.mirroringDeploymentGroups.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"mirroringDeploymentGroupId": { +"description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_group_id from the method_signature of Create RPC", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Value for parent.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" } }, -"path": "v1beta1/{+name}:cancel", +"path": "v1beta1/{+parent}/mirroringDeploymentGroups", "request": { -"$ref": "CancelOperationRequest" +"$ref": "MirroringDeploymentGroup" }, "response": { -"$ref": "Empty" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"description": "Deletes a single MirroringDeploymentGroup.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", "httpMethod": "DELETE", -"id": "networksecurity.projects.locations.operations.delete", +"id": "networksecurity.projects.locations.mirroringDeploymentGroups.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. Name of the resource", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", "required": true, "type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "Empty" +"$ref": "Operation" }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"description": "Gets details of a single MirroringDeploymentGroup.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", "httpMethod": "GET", -"id": "networksecurity.projects.locations.operations.get", +"id": "networksecurity.projects.locations.mirroringDeploymentGroups.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. Name of the resource", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "Operation" +"$ref": "MirroringDeploymentGroup" }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", +"description": "Lists MirroringDeploymentGroups in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups", "httpMethod": "GET", -"id": "networksecurity.projects.locations.operations.list", +"id": "networksecurity.projects.locations.mirroringDeploymentGroups.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Optional. Filtering results", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, +"orderBy": { +"description": "Optional. Hint for how to order the results", +"location": "query", "type": "string" }, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListMirroringDeploymentGroupsRequest", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/mirroringDeploymentGroups", +"response": { +"$ref": "ListMirroringDeploymentGroupsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a single MirroringDeploymentGroup.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", +"httpMethod": "PATCH", +"id": "networksecurity.projects.locations.mirroringDeploymentGroups.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Identifier. Then name of the MirroringDeploymentGroup.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringDeploymentGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", "location": "query", "type": "string" } }, -"path": "v1beta1/{+name}/operations", +"path": "v1beta1/{+name}", +"request": { +"$ref": "MirroringDeploymentGroup" +}, "response": { -"$ref": "ListOperationsResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -2863,33 +2922,38 @@ } } }, -"serverTlsPolicies": { +"mirroringDeployments": { "methods": { "create": { -"description": "Creates a new ServerTlsPolicy in a given project and location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies", +"description": "Creates a new MirroringDeployment in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments", "httpMethod": "POST", -"id": "networksecurity.projects.locations.serverTlsPolicies.create", +"id": "networksecurity.projects.locations.mirroringDeployments.create", "parameterOrder": [ "parent" ], "parameters": { +"mirroringDeploymentId": { +"description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent resource of the ServerTlsPolicy. Must be in the format `projects/*/locations/{location}`.", +"description": "Required. Value for parent.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, -"serverTlsPolicyId": { -"description": "Required. Short name of the ServerTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. \"server_mtls_policy\".", +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, -"path": "v1beta1/{+parent}/serverTlsPolicies", +"path": "v1beta1/{+parent}/mirroringDeployments", "request": { -"$ref": "ServerTlsPolicy" +"$ref": "MirroringDeployment" }, "response": { "$ref": "Operation" @@ -2899,20 +2963,25 @@ ] }, "delete": { -"description": "Deletes a single ServerTlsPolicy.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", +"description": "Deletes a single MirroringDeployment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", "httpMethod": "DELETE", -"id": "networksecurity.projects.locations.serverTlsPolicies.delete", +"id": "networksecurity.projects.locations.mirroringDeployments.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. A name of the ServerTlsPolicy to delete. Must be in the format `projects/*/locations/{location}/serverTlsPolicies/*`.", +"description": "Required. Name of the resource", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", "required": true, "type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" } }, "path": "v1beta1/{+name}", @@ -2924,115 +2993,99 @@ ] }, "get": { -"description": "Gets details of a single ServerTlsPolicy.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", +"description": "Gets details of a single MirroringDeployment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", "httpMethod": "GET", -"id": "networksecurity.projects.locations.serverTlsPolicies.get", +"id": "networksecurity.projects.locations.mirroringDeployments.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. A name of the ServerTlsPolicy to get. Must be in the format `projects/*/locations/{location}/serverTlsPolicies/*`.", +"description": "Required. Name of the resource", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "ServerTlsPolicy" +"$ref": "MirroringDeployment" }, "scopes": [ "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}/serverTlsPolicies/{serverTlsPoliciesId}:getIamPolicy", +"list": { +"description": "Lists MirroringDeployments in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments", "httpMethod": "GET", -"id": "networksecurity.projects.locations.serverTlsPolicies.getIamPolicy", +"id": "networksecurity.projects.locations.mirroringDeployments.list", "parameterOrder": [ -"resource" +"parent" ], "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", +"filter": { +"description": "Optional. Filtering results", "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/[^/]+/serverTlsPolicies/[^/]+$", -"required": true, "type": "string" -} -}, -"path": "v1beta1/{+resource}:getIamPolicy", -"response": { -"$ref": "GoogleIamV1Policy" }, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] +"orderBy": { +"description": "Optional. Hint for how to order the results", +"location": "query", +"type": "string" }, -"list": { -"description": "Lists ServerTlsPolicies in a given project and location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies", -"httpMethod": "GET", -"id": "networksecurity.projects.locations.serverTlsPolicies.list", -"parameterOrder": [ -"parent" -], -"parameters": { "pageSize": { -"description": "Maximum number of ServerTlsPolicies to return per call.", +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListServerTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListServerTlsPolicies` call, and that the system should return the next page of data.", +"description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The project and location from which the ServerTlsPolicies should be listed, specified in the format `projects/*/locations/{location}`.", +"description": "Required. Parent value for ListMirroringDeploymentsRequest", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/serverTlsPolicies", +"path": "v1beta1/{+parent}/mirroringDeployments", "response": { -"$ref": "ListServerTlsPoliciesResponse" +"$ref": "ListMirroringDeploymentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Updates the parameters of a single ServerTlsPolicy.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", +"description": "Updates a single MirroringDeployment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", "httpMethod": "PATCH", -"id": "networksecurity.projects.locations.serverTlsPolicies.patch", +"id": "networksecurity.projects.locations.mirroringDeployments.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`", +"description": "Immutable. Identifier. The name of the MirroringDeployment.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", "required": true, "type": "string" }, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, "updateMask": { -"description": "Optional. Field mask is used to specify the fields to be overwritten in the ServerTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringDeployment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3040,7 +3093,7 @@ }, "path": "v1beta1/{+name}", "request": { -"$ref": "ServerTlsPolicy" +"$ref": "MirroringDeployment" }, "response": { "$ref": "Operation" @@ -3048,72 +3101,747 @@ "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}/serverTlsPolicies/{serverTlsPoliciesId}:setIamPolicy", +"mirroringEndpointGroupAssociations": { +"methods": { +"create": { +"description": "Creates a new MirroringEndpointGroupAssociation in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations", "httpMethod": "POST", -"id": "networksecurity.projects.locations.serverTlsPolicies.setIamPolicy", +"id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.create", "parameterOrder": [ -"resource" +"parent" ], "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.", +"mirroringEndpointGroupAssociationId": { +"description": "Optional. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_association_id from the method_signature of Create RPC", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Value for parent.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" } }, -"path": "v1beta1/{+resource}:setIamPolicy", +"path": "v1beta1/{+parent}/mirroringEndpointGroupAssociations", "request": { -"$ref": "GoogleIamV1SetIamPolicyRequest" +"$ref": "MirroringEndpointGroupAssociation" }, "response": { -"$ref": "GoogleIamV1Policy" +"$ref": "Operation" }, "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}/serverTlsPolicies/{serverTlsPoliciesId}:testIamPermissions", -"httpMethod": "POST", -"id": "networksecurity.projects.locations.serverTlsPolicies.testIamPermissions", +"delete": { +"description": "Deletes a single MirroringEndpointGroupAssociation.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", +"httpMethod": "DELETE", +"id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.delete", "parameterOrder": [ -"resource" +"name" ], "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.", +"name": { +"description": "Required. Name of the resource", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1beta1/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} }, +"path": "v1beta1/{+name}", "response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"tlsInspectionPolicies": { -"methods": { -"create": { -"description": "Creates a new TlsInspectionPolicy in a given project and location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies", -"httpMethod": "POST", -"id": "networksecurity.projects.locations.tlsInspectionPolicies.create", +"get": { +"description": "Gets details of a single MirroringEndpointGroupAssociation.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "MirroringEndpointGroupAssociation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists MirroringEndpointGroupAssociations in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Hint for how to order the results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListMirroringEndpointGroupAssociationsRequest", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/mirroringEndpointGroupAssociations", +"response": { +"$ref": "ListMirroringEndpointGroupAssociationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a single MirroringEndpointGroupAssociation.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", +"httpMethod": "PATCH", +"id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Identifier. The name of the MirroringEndpointGroupAssociation.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringEndpointGroupAssociation resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "MirroringEndpointGroupAssociation" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"mirroringEndpointGroups": { +"methods": { +"create": { +"description": "Creates a new MirroringEndpointGroup in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups", +"httpMethod": "POST", +"id": "networksecurity.projects.locations.mirroringEndpointGroups.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"mirroringEndpointGroupId": { +"description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_id from the method_signature of Create RPC", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Value for parent.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/mirroringEndpointGroups", +"request": { +"$ref": "MirroringEndpointGroup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single MirroringEndpointGroup.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", +"httpMethod": "DELETE", +"id": "networksecurity.projects.locations.mirroringEndpointGroups.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single MirroringEndpointGroup.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.mirroringEndpointGroups.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "MirroringEndpointGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists MirroringEndpointGroups in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.mirroringEndpointGroups.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Hint for how to order the results", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListMirroringEndpointGroupsRequest", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/mirroringEndpointGroups", +"response": { +"$ref": "ListMirroringEndpointGroupsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a single MirroringEndpointGroup.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", +"httpMethod": "PATCH", +"id": "networksecurity.projects.locations.mirroringEndpointGroups.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Identifier. The name of the MirroringEndpointGroup.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringEndpointGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "MirroringEndpointGroup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "networksecurity.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "networksecurity.projects.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"serverTlsPolicies": { +"methods": { +"create": { +"description": "Creates a new ServerTlsPolicy in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies", +"httpMethod": "POST", +"id": "networksecurity.projects.locations.serverTlsPolicies.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the ServerTlsPolicy. Must be in the format `projects/*/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"serverTlsPolicyId": { +"description": "Required. Short name of the ServerTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. \"server_mtls_policy\".", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/serverTlsPolicies", +"request": { +"$ref": "ServerTlsPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single ServerTlsPolicy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", +"httpMethod": "DELETE", +"id": "networksecurity.projects.locations.serverTlsPolicies.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the ServerTlsPolicy to delete. Must be in the format `projects/*/locations/{location}/serverTlsPolicies/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single ServerTlsPolicy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.serverTlsPolicies.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the ServerTlsPolicy to get. Must be in the format `projects/*/locations/{location}/serverTlsPolicies/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "ServerTlsPolicy" +}, +"scopes": [ +"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}/serverTlsPolicies/{serverTlsPoliciesId}:getIamPolicy", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.serverTlsPolicies.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/[^/]+/serverTlsPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists ServerTlsPolicies in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.serverTlsPolicies.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of ServerTlsPolicies to return per call.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The value returned by the last `ListServerTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListServerTlsPolicies` call, and that the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location from which the ServerTlsPolicies should be listed, specified in the format `projects/*/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/serverTlsPolicies", +"response": { +"$ref": "ListServerTlsPoliciesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single ServerTlsPolicy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}", +"httpMethod": "PATCH", +"id": "networksecurity.projects.locations.serverTlsPolicies.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/serverTlsPolicies/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the ServerTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "ServerTlsPolicy" +}, +"response": { +"$ref": "Operation" +}, +"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}/serverTlsPolicies/{serverTlsPoliciesId}:setIamPolicy", +"httpMethod": "POST", +"id": "networksecurity.projects.locations.serverTlsPolicies.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/[^/]+/serverTlsPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+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": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}:testIamPermissions", +"httpMethod": "POST", +"id": "networksecurity.projects.locations.serverTlsPolicies.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/[^/]+/serverTlsPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"tlsInspectionPolicies": { +"methods": { +"create": { +"description": "Creates a new TlsInspectionPolicy in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies", +"httpMethod": "POST", +"id": "networksecurity.projects.locations.tlsInspectionPolicies.create", "parameterOrder": [ "parent" ], @@ -3431,7 +4159,7 @@ } } }, -"revision": "20240803", +"revision": "20240828", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -4186,14 +4914,16 @@ "CREATING", "ACTIVE", "DELETING", -"INACTIVE" +"INACTIVE", +"ORPHAN" ], "enumDescriptions": [ "Not set.", "Being created.", "Active and ready for traffic.", "Being deleted.", -"Down or in an error state." +"Down or in an error state.", +"The GCP project that housed the association has been deleted." ], "readOnly": true, "type": "string" @@ -4674,19 +5404,105 @@ }, "type": "object" }, -"ListGatewaySecurityPoliciesResponse": { -"description": "Response returned by the ListGatewaySecurityPolicies method.", -"id": "ListGatewaySecurityPoliciesResponse", +"ListGatewaySecurityPoliciesResponse": { +"description": "Response returned by the ListGatewaySecurityPolicies method.", +"id": "ListGatewaySecurityPoliciesResponse", +"properties": { +"gatewaySecurityPolicies": { +"description": "List of GatewaySecurityPolicies resources.", +"items": { +"$ref": "GatewaySecurityPolicy" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListGatewaySecurityPolicyRulesResponse": { +"description": "Response returned by the ListGatewaySecurityPolicyRules method.", +"id": "ListGatewaySecurityPolicyRulesResponse", +"properties": { +"gatewaySecurityPolicyRules": { +"description": "List of GatewaySecurityPolicyRule resources.", +"items": { +"$ref": "GatewaySecurityPolicyRule" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListLocationsResponse": { +"description": "The response message for Locations.ListLocations.", +"id": "ListLocationsResponse", +"properties": { +"locations": { +"description": "A list of locations that matches the specified filter in the request.", +"items": { +"$ref": "Location" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +} +}, +"type": "object" +}, +"ListMirroringDeploymentGroupsResponse": { +"description": "Message for response to listing MirroringDeploymentGroups", +"id": "ListMirroringDeploymentGroupsResponse", +"properties": { +"mirroringDeploymentGroups": { +"description": "The list of MirroringDeploymentGroup", +"items": { +"$ref": "MirroringDeploymentGroup" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +} +}, +"type": "object" +}, +"ListMirroringDeploymentsResponse": { +"description": "Message for response to listing MirroringDeployments", +"id": "ListMirroringDeploymentsResponse", "properties": { -"gatewaySecurityPolicies": { -"description": "List of GatewaySecurityPolicies resources.", +"mirroringDeployments": { +"description": "The list of MirroringDeployment", "items": { -"$ref": "GatewaySecurityPolicy" +"$ref": "MirroringDeployment" }, "type": "array" }, "nextPageToken": { -"description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", +"description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { @@ -4699,44 +5515,37 @@ }, "type": "object" }, -"ListGatewaySecurityPolicyRulesResponse": { -"description": "Response returned by the ListGatewaySecurityPolicyRules method.", -"id": "ListGatewaySecurityPolicyRulesResponse", +"ListMirroringEndpointGroupAssociationsResponse": { +"description": "Message for response to listing MirroringEndpointGroupAssociations", +"id": "ListMirroringEndpointGroupAssociationsResponse", "properties": { -"gatewaySecurityPolicyRules": { -"description": "List of GatewaySecurityPolicyRule resources.", +"mirroringEndpointGroupAssociations": { +"description": "The list of MirroringEndpointGroupAssociation", "items": { -"$ref": "GatewaySecurityPolicyRule" +"$ref": "MirroringEndpointGroupAssociation" }, "type": "array" }, "nextPageToken": { -"description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", -"type": "string" -}, -"unreachable": { -"description": "Locations that could not be reached.", -"items": { +"description": "A token identifying a page of results the server should return.", "type": "string" -}, -"type": "array" } }, "type": "object" }, -"ListLocationsResponse": { -"description": "The response message for Locations.ListLocations.", -"id": "ListLocationsResponse", +"ListMirroringEndpointGroupsResponse": { +"description": "Message for response to listing MirroringEndpointGroups", +"id": "ListMirroringEndpointGroupsResponse", "properties": { -"locations": { -"description": "A list of locations that matches the specified filter in the request.", +"mirroringEndpointGroups": { +"description": "The list of MirroringEndpointGroup", "items": { -"$ref": "Location" +"$ref": "MirroringEndpointGroup" }, "type": "array" }, "nextPageToken": { -"description": "The standard List next-page token.", +"description": "A token identifying a page of results the server should return.", "type": "string" } }, @@ -4930,6 +5739,309 @@ }, "type": "object" }, +"MirroringDeployment": { +"description": "Message describing MirroringDeployment object", +"id": "MirroringDeployment", +"properties": { +"createTime": { +"description": "Output only. [Output only] Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"forwardingRule": { +"description": "Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"mirroringDeploymentGroup": { +"description": "Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The name of the MirroringDeployment.", +"type": "string" +}, +"reconciling": { +"description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. Current state of the deployment.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"CREATING", +"DELETING", +"OUT_OF_SYNC", +"DELETE_FAILED" +], +"enumDescriptions": [ +"Not set.", +"Ready.", +"Being created.", +"Being deleted.", +"The underlying data plane is out of sync with the deployment. The deployment is not expected to be usable. This state can result in undefined behavior.", +"An attempt to delete the deployment has failed. This is a terminal state and the deployment is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the deployment." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. [Output only] Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MirroringDeploymentGroup": { +"description": "Message describing MirroringDeploymentGroup object", +"id": "MirroringDeploymentGroup", +"properties": { +"connectedEndpointGroups": { +"description": "Output only. The list of Mirroring Endpoint Groups that are connected to this resource.", +"items": { +"$ref": "MirroringDeploymentGroupConnectedEndpointGroup" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. [Output only] Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"name": { +"description": "Immutable. Identifier. Then name of the MirroringDeploymentGroup.", +"type": "string" +}, +"network": { +"description": "Required. Immutable. The network that is being used for the deployment. Format is: projects/{project}/global/networks/{network}.", +"type": "string" +}, +"reconciling": { +"description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. Current state of the deployment group.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"CREATING", +"DELETING" +], +"enumDescriptions": [ +"Not set.", +"Ready.", +"Being created.", +"Being deleted." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. [Output only] Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MirroringDeploymentGroupConnectedEndpointGroup": { +"description": "An endpoint group connected to this deployment group.", +"id": "MirroringDeploymentGroupConnectedEndpointGroup", +"properties": { +"name": { +"description": "Output only. A connected mirroring endpoint group.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MirroringEndpointGroup": { +"description": "Message describing MirroringEndpointGroup object", +"id": "MirroringEndpointGroup", +"properties": { +"createTime": { +"description": "Output only. [Output only] Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"mirroringDeploymentGroup": { +"description": "Required. Immutable. The Mirroring Deployment Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The name of the MirroringEndpointGroup.", +"type": "string" +}, +"reconciling": { +"description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. Current state of the endpoint group.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"CLOSED", +"CREATING", +"DELETING", +"OUT_OF_SYNC", +"DELETE_FAILED" +], +"enumDescriptions": [ +"Not set.", +"Ready.", +"The deployment group has been deleted and mirroring is disabled.", +"Being created.", +"Being deleted.", +"The underlying data plane is out of sync with the endpoint group. Some associations might not be usable.", +"An attempt to delete the endpoint group has failed. This is a terminal state and the endpoint group is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the endpoint group." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. [Output only] Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MirroringEndpointGroupAssociation": { +"description": "Message describing MirroringEndpointGroupAssociation object", +"id": "MirroringEndpointGroupAssociation", +"properties": { +"createTime": { +"description": "Output only. [Output only] Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"locationsDetails": { +"description": "Output only. The list of locations that this association is in and its details.", +"items": { +"$ref": "MirroringEndpointGroupAssociationLocationDetails" +}, +"readOnly": true, +"type": "array" +}, +"mirroringEndpointGroup": { +"description": "Required. Immutable. The Mirroring Endpoint Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringEndpointGroups/{mirroringEndpointGroup}`", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The name of the MirroringEndpointGroupAssociation.", +"type": "string" +}, +"network": { +"description": "Required. Immutable. The VPC network associated. Format: projects/{project}/global/networks/{network}.", +"type": "string" +}, +"reconciling": { +"description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. Current state of the endpoint group association.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"CREATING", +"DELETING", +"CLOSED", +"OUT_OF_SYNC", +"DELETE_FAILED" +], +"enumDescriptions": [ +"Not set.", +"Ready.", +"Being created.", +"Being deleted.", +"Mirroring is disabled due to an operation on another resource.", +"The underlying data plane is out of sync with the association. The association is not expected to be usable. This state can result in undefined behavior. See the `locations_details` field for more details.", +"An attempt to delete the association has failed. This is a terminal state and the association is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the association." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. [Output only] Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MirroringEndpointGroupAssociationLocationDetails": { +"description": "Details about the association status in a specific cloud location.", +"id": "MirroringEndpointGroupAssociationLocationDetails", +"properties": { +"location": { +"description": "Output only. The cloud location.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The association state in this location.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"OUT_OF_SYNC" +], +"enumDescriptions": [ +"Not set.", +"Ready.", +"The data plane is out of sync with the association in this location." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1.json b/googleapiclient/discovery_cache/documents/osconfig.v1.json index ad1e8b959a3..10c512d5b3a 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1.json @@ -1083,7 +1083,7 @@ } } }, -"revision": "20240630", +"revision": "20240901", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -1565,7 +1565,7 @@ "AVAILABLE_PACKAGE" ], "enumDescriptions": [ -"Invalid. An type must be specified.", +"Invalid. A type must be specified.", "This represents a package that is installed on the VM.", "This represents an update that is available for a package." ], @@ -2480,7 +2480,7 @@ "type": "string" }, "outputFilePath": { -"description": "Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.", +"description": "Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 500K bytes.", "type": "string" }, "script": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json index eb91eb5734a..1ade03dd8dc 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json @@ -707,7 +707,7 @@ } } }, -"revision": "20240630", +"revision": "20240901", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { @@ -1141,7 +1141,7 @@ "AVAILABLE_PACKAGE" ], "enumDescriptions": [ -"Invalid. An type must be specified.", +"Invalid. A type must be specified.", "This represents a package that is installed on the VM.", "This represents an update that is available for a package." ], diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 6e2c5823f7e..eadf127fbb5 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -849,7 +849,7 @@ } } }, -"revision": "20240822", +"revision": "20240904", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -875,6 +875,42 @@ }, "type": "object" }, +"AssetLocation": { +"description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", +"id": "AssetLocation", +"properties": { +"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." +}, +"extraParameters": { +"description": "Defines extra parameters required for specific asset types.", +"items": { +"$ref": "ExtraParameter" +}, +"type": "array" +}, +"locationData": { +"description": "Contains all kinds of physical location definitions for this asset.", +"items": { +"$ref": "LocationData" +}, +"type": "array" +}, +"parentAsset": { +"description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", +"items": { +"$ref": "CloudAsset" +}, +"type": "array" +} +}, +"type": "object" +}, "AvailabilityConfiguration": { "description": "Configuration for availability of database instance", "id": "AvailabilityConfiguration", @@ -968,6 +1004,19 @@ }, "type": "object" }, +"BlobstoreLocation": { +"description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", +"id": "BlobstoreLocation", +"properties": { +"policyId": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "CertChain": { "id": "CertChain", "properties": { @@ -995,6 +1044,30 @@ }, "type": "object" }, +"CloudAsset": { +"id": "CloudAsset", +"properties": { +"assetName": { +"type": "string" +}, +"assetType": { +"type": "string" +} +}, +"type": "object" +}, +"CloudAssetComposition": { +"id": "CloudAssetComposition", +"properties": { +"childAsset": { +"items": { +"$ref": "CloudAsset" +}, +"type": "array" +} +}, +"type": "object" +}, "Cluster": { "description": "A cluster instance.", "id": "Cluster", @@ -1822,7 +1895,7 @@ false "type": "object" }, "DatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata.", +"description": "Common model for database resource instance metadata. Next ID: 21", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -1961,6 +2034,10 @@ false "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, +"tagsSet": { +"$ref": "Tags", +"description": "Optional. Tags associated with this resources." +}, "updationTime": { "description": "The time at which the resource was updated and recorded at partner service.", "format": "google-datetime", @@ -2276,6 +2353,18 @@ false }, "type": "object" }, +"DirectLocationAssignment": { +"id": "DirectLocationAssignment", +"properties": { +"location": { +"items": { +"$ref": "LocationAssignment" +}, +"type": "array" +} +}, +"type": "object" +}, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", @@ -2349,6 +2438,17 @@ false }, "type": "object" }, +"ExtraParameter": { +"description": "Defines parameters that should only be used for specific asset types.", +"id": "ExtraParameter", +"properties": { +"regionalMigDistributionPolicy": { +"$ref": "RegionalMigDistributionPolicy", +"description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." +} +}, +"type": "object" +}, "FailoverInstanceRequest": { "description": "Request for Failover.", "id": "FailoverInstanceRequest", @@ -2770,6 +2870,131 @@ false }, "type": "object" }, +"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", +"ZI_UNKNOWN", +"ZI_NOT_REQUIRED", +"ZI_PREFERRED", +"ZI_REQUIRED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"", +"" +], +"type": "string" +}, +"ziRegionPolicy": { +"enum": [ +"ZI_REGION_POLICY_UNSPECIFIED", +"ZI_REGION_POLICY_UNKNOWN", +"ZI_REGION_POLICY_NOT_SET", +"ZI_REGION_POLICY_FAIL_OPEN", +"ZI_REGION_POLICY_FAIL_CLOSED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"", +"" +], +"type": "string" +}, +"ziRegionState": { +"enum": [ +"ZI_REGION_UNSPECIFIED", +"ZI_REGION_UNKNOWN", +"ZI_REGION_NOT_ENABLED", +"ZI_REGION_ENABLED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"" +], +"type": "string" +}, +"zoneIsolation": { +"deprecated": true, +"description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", +"enum": [ +"ZI_UNSPECIFIED", +"ZI_UNKNOWN", +"ZI_NOT_REQUIRED", +"ZI_PREFERRED", +"ZI_REQUIRED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"", +"" +], +"type": "string" +}, +"zoneSeparation": { +"deprecated": true, +"description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", +"enum": [ +"ZS_UNSPECIFIED", +"ZS_UNKNOWN", +"ZS_NOT_REQUIRED", +"ZS_REQUIRED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"" +], +"type": "string" +}, +"zsOrgPolicy": { +"enum": [ +"ZS_UNSPECIFIED", +"ZS_UNKNOWN", +"ZS_NOT_REQUIRED", +"ZS_REQUIRED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"" +], +"type": "string" +}, +"zsRegionState": { +"enum": [ +"ZS_REGION_UNSPECIFIED", +"ZS_REGION_UNKNOWN", +"ZS_REGION_NOT_ENABLED", +"ZS_REGION_ENABLED" +], +"enumDescriptions": [ +"", +"To be used if tracking of the asset ZS-bit is not available", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, "ListClustersResponse": { "description": "Response for ListClusters.", "id": "ListClustersResponse", @@ -2890,6 +3115,64 @@ false }, "type": "object" }, +"LocationAssignment": { +"id": "LocationAssignment", +"properties": { +"location": { +"type": "string" +}, +"locationType": { +"enum": [ +"UNSPECIFIED", +"CLUSTER", +"POP", +"CLOUD_ZONE", +"CLOUD_REGION", +"MULTI_REGION_GEO", +"MULTI_REGION_JURISDICTION", +"GLOBAL", +"OTHER" +], +"enumDescriptions": [ +"", +"1-10: Physical failure domains.", +"", +"11-20: Logical failure domains.", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"LocationData": { +"id": "LocationData", +"properties": { +"blobstoreLocation": { +"$ref": "BlobstoreLocation" +}, +"childAssetLocation": { +"$ref": "CloudAssetComposition" +}, +"directLocation": { +"$ref": "DirectLocationAssignment" +}, +"gcpProjectProxy": { +"$ref": "TenantProjectProxy" +}, +"placerLocation": { +"$ref": "PlacerLocation" +}, +"spannerLocation": { +"$ref": "SpannerLocation" +} +}, +"type": "object" +}, "MachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "MachineConfiguration", @@ -3250,6 +3533,17 @@ false }, "type": "object" }, +"PlacerLocation": { +"description": "Message describing that the location of the customer resource is tied to placer allocations", +"id": "PlacerLocation", +"properties": { +"placerConfig": { +"description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", +"type": "string" +} +}, +"type": "object" +}, "Product": { "description": "Product specification for Condor resources.", "id": "Product", @@ -3467,6 +3761,25 @@ false }, "type": "object" }, +"RegionalMigDistributionPolicy": { +"description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", +"id": "RegionalMigDistributionPolicy", +"properties": { +"targetShape": { +"description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", +"format": "int32", +"type": "integer" +}, +"zones": { +"description": "Cloud zones used by regional MIG to create instances.", +"items": { +"$ref": "ZoneConfiguration" +}, +"type": "array" +} +}, +"type": "object" +}, "RemoteCluster": { "description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.", "id": "RemoteCluster", @@ -3483,6 +3796,44 @@ false }, "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" +}, "RescheduleClusterMaintenanceRequest": { "description": "Request for rescheduling a cluster maintenance.", "id": "RescheduleClusterMaintenanceRequest", @@ -3567,6 +3918,26 @@ false }, "type": "object" }, +"SpannerLocation": { +"id": "SpannerLocation", +"properties": { +"backupName": { +"description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", +"items": { +"type": "string" +}, +"type": "array" +}, +"dbName": { +"description": "Set of databases used by the resource in format /span//", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "StateInfo": { "description": "Represents additional information about the state of the cluster.", "id": "StateInfo", @@ -3605,6 +3976,32 @@ false }, "type": "object" }, +"Tags": { +"description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", +"id": "Tags", +"properties": { +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "The Tag key/value mappings.", +"type": "object" +} +}, +"type": "object" +}, +"TenantProjectProxy": { +"id": "TenantProjectProxy", +"properties": { +"projectNumbers": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"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", @@ -3770,6 +4167,15 @@ false }, "type": "object" }, +"ZoneConfiguration": { +"id": "ZoneConfiguration", +"properties": { +"zone": { +"type": "string" +} +}, +"type": "object" +}, "ZoneDistributionConfig": { "description": "Zone distribution config for allocation of cluster resources.", "id": "ZoneDistributionConfig", diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index a0db65ba31a..6f1f5d58db7 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -849,7 +849,7 @@ } } }, -"revision": "20240822", +"revision": "20240904", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -875,6 +875,42 @@ }, "type": "object" }, +"AssetLocation": { +"description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", +"id": "AssetLocation", +"properties": { +"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." +}, +"extraParameters": { +"description": "Defines extra parameters required for specific asset types.", +"items": { +"$ref": "ExtraParameter" +}, +"type": "array" +}, +"locationData": { +"description": "Contains all kinds of physical location definitions for this asset.", +"items": { +"$ref": "LocationData" +}, +"type": "array" +}, +"parentAsset": { +"description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", +"items": { +"$ref": "CloudAsset" +}, +"type": "array" +} +}, +"type": "object" +}, "AvailabilityConfiguration": { "description": "Configuration for availability of database instance", "id": "AvailabilityConfiguration", @@ -968,6 +1004,19 @@ }, "type": "object" }, +"BlobstoreLocation": { +"description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", +"id": "BlobstoreLocation", +"properties": { +"policyId": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "CertChain": { "id": "CertChain", "properties": { @@ -995,6 +1044,30 @@ }, "type": "object" }, +"CloudAsset": { +"id": "CloudAsset", +"properties": { +"assetName": { +"type": "string" +}, +"assetType": { +"type": "string" +} +}, +"type": "object" +}, +"CloudAssetComposition": { +"id": "CloudAssetComposition", +"properties": { +"childAsset": { +"items": { +"$ref": "CloudAsset" +}, +"type": "array" +} +}, +"type": "object" +}, "Cluster": { "description": "A cluster instance.", "id": "Cluster", @@ -1822,7 +1895,7 @@ false "type": "object" }, "DatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata.", +"description": "Common model for database resource instance metadata. Next ID: 21", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -1961,6 +2034,10 @@ false "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, +"tagsSet": { +"$ref": "Tags", +"description": "Optional. Tags associated with this resources." +}, "updationTime": { "description": "The time at which the resource was updated and recorded at partner service.", "format": "google-datetime", @@ -2276,6 +2353,18 @@ false }, "type": "object" }, +"DirectLocationAssignment": { +"id": "DirectLocationAssignment", +"properties": { +"location": { +"items": { +"$ref": "LocationAssignment" +}, +"type": "array" +} +}, +"type": "object" +}, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", @@ -2349,6 +2438,17 @@ false }, "type": "object" }, +"ExtraParameter": { +"description": "Defines parameters that should only be used for specific asset types.", +"id": "ExtraParameter", +"properties": { +"regionalMigDistributionPolicy": { +"$ref": "RegionalMigDistributionPolicy", +"description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." +} +}, +"type": "object" +}, "FailoverInstanceRequest": { "description": "Request for Failover.", "id": "FailoverInstanceRequest", @@ -2777,6 +2877,131 @@ false }, "type": "object" }, +"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", +"ZI_UNKNOWN", +"ZI_NOT_REQUIRED", +"ZI_PREFERRED", +"ZI_REQUIRED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"", +"" +], +"type": "string" +}, +"ziRegionPolicy": { +"enum": [ +"ZI_REGION_POLICY_UNSPECIFIED", +"ZI_REGION_POLICY_UNKNOWN", +"ZI_REGION_POLICY_NOT_SET", +"ZI_REGION_POLICY_FAIL_OPEN", +"ZI_REGION_POLICY_FAIL_CLOSED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"", +"" +], +"type": "string" +}, +"ziRegionState": { +"enum": [ +"ZI_REGION_UNSPECIFIED", +"ZI_REGION_UNKNOWN", +"ZI_REGION_NOT_ENABLED", +"ZI_REGION_ENABLED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"" +], +"type": "string" +}, +"zoneIsolation": { +"deprecated": true, +"description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", +"enum": [ +"ZI_UNSPECIFIED", +"ZI_UNKNOWN", +"ZI_NOT_REQUIRED", +"ZI_PREFERRED", +"ZI_REQUIRED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"", +"" +], +"type": "string" +}, +"zoneSeparation": { +"deprecated": true, +"description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", +"enum": [ +"ZS_UNSPECIFIED", +"ZS_UNKNOWN", +"ZS_NOT_REQUIRED", +"ZS_REQUIRED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"" +], +"type": "string" +}, +"zsOrgPolicy": { +"enum": [ +"ZS_UNSPECIFIED", +"ZS_UNKNOWN", +"ZS_NOT_REQUIRED", +"ZS_REQUIRED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"" +], +"type": "string" +}, +"zsRegionState": { +"enum": [ +"ZS_REGION_UNSPECIFIED", +"ZS_REGION_UNKNOWN", +"ZS_REGION_NOT_ENABLED", +"ZS_REGION_ENABLED" +], +"enumDescriptions": [ +"", +"To be used if tracking of the asset ZS-bit is not available", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, "ListClustersResponse": { "description": "Response for ListClusters.", "id": "ListClustersResponse", @@ -2897,6 +3122,64 @@ false }, "type": "object" }, +"LocationAssignment": { +"id": "LocationAssignment", +"properties": { +"location": { +"type": "string" +}, +"locationType": { +"enum": [ +"UNSPECIFIED", +"CLUSTER", +"POP", +"CLOUD_ZONE", +"CLOUD_REGION", +"MULTI_REGION_GEO", +"MULTI_REGION_JURISDICTION", +"GLOBAL", +"OTHER" +], +"enumDescriptions": [ +"", +"1-10: Physical failure domains.", +"", +"11-20: Logical failure domains.", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"LocationData": { +"id": "LocationData", +"properties": { +"blobstoreLocation": { +"$ref": "BlobstoreLocation" +}, +"childAssetLocation": { +"$ref": "CloudAssetComposition" +}, +"directLocation": { +"$ref": "DirectLocationAssignment" +}, +"gcpProjectProxy": { +"$ref": "TenantProjectProxy" +}, +"placerLocation": { +"$ref": "PlacerLocation" +}, +"spannerLocation": { +"$ref": "SpannerLocation" +} +}, +"type": "object" +}, "MachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "MachineConfiguration", @@ -3257,6 +3540,17 @@ false }, "type": "object" }, +"PlacerLocation": { +"description": "Message describing that the location of the customer resource is tied to placer allocations", +"id": "PlacerLocation", +"properties": { +"placerConfig": { +"description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", +"type": "string" +} +}, +"type": "object" +}, "Product": { "description": "Product specification for Condor resources.", "id": "Product", @@ -3474,6 +3768,25 @@ false }, "type": "object" }, +"RegionalMigDistributionPolicy": { +"description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", +"id": "RegionalMigDistributionPolicy", +"properties": { +"targetShape": { +"description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", +"format": "int32", +"type": "integer" +}, +"zones": { +"description": "Cloud zones used by regional MIG to create instances.", +"items": { +"$ref": "ZoneConfiguration" +}, +"type": "array" +} +}, +"type": "object" +}, "RemoteCluster": { "description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.", "id": "RemoteCluster", @@ -3490,6 +3803,44 @@ false }, "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" +}, "RescheduleClusterMaintenanceRequest": { "description": "Request for rescheduling a cluster maintenance.", "id": "RescheduleClusterMaintenanceRequest", @@ -3574,6 +3925,26 @@ false }, "type": "object" }, +"SpannerLocation": { +"id": "SpannerLocation", +"properties": { +"backupName": { +"description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", +"items": { +"type": "string" +}, +"type": "array" +}, +"dbName": { +"description": "Set of databases used by the resource in format /span//", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "StateInfo": { "description": "Represents additional information about the state of the cluster.", "id": "StateInfo", @@ -3612,6 +3983,32 @@ false }, "type": "object" }, +"Tags": { +"description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", +"id": "Tags", +"properties": { +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "The Tag key/value mappings.", +"type": "object" +} +}, +"type": "object" +}, +"TenantProjectProxy": { +"id": "TenantProjectProxy", +"properties": { +"projectNumbers": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"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", @@ -3777,6 +4174,15 @@ false }, "type": "object" }, +"ZoneConfiguration": { +"id": "ZoneConfiguration", +"properties": { +"zone": { +"type": "string" +} +}, +"type": "object" +}, "ZoneDistributionConfig": { "description": "Zone distribution config for allocation of cluster resources.", "id": "ZoneDistributionConfig", diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index f67c216b419..00ec8b7b03a 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1526,7 +1526,7 @@ } } }, -"revision": "20240823", +"revision": "20240831", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2984,7 +2984,7 @@ "id": "GoogleCloudRunV2RevisionScaling", "properties": { "maxInstanceCount": { -"description": "Optional. Maximum number of serving instances that this resource should have.", +"description": "Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances", "format": "int32", "type": "integer" }, @@ -3468,6 +3468,10 @@ "description": "URI of the base builder image in Artifact Registry being used in the build. Used to opt into automatic base image updates.", "type": "string" }, +"baseImageWarning": { +"description": "Warning message for the base image.", +"type": "string" +}, "buildOperation": { "$ref": "GoogleLongrunningOperation", "description": "Cloud Build operation to be polled via CloudBuild API." diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index ff53a216fd0..dd60d5b5589 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1029,7 +1029,7 @@ } } }, -"revision": "20240825", +"revision": "20240901", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -3253,7 +3253,7 @@ "type": "string" }, "role": { -"description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project - 'roles/monitoring.viewer' applied on the shared VPC host project", +"description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project - 'roles/monitoring.viewer' applied on the shared VPC host project - 'roles/servicemanagement.quotaViewer' applied on the shared VPC host project", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index 03d48475276..2fd64eeb10f 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20240825", +"revision": "20240901", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -2273,7 +2273,7 @@ "type": "string" }, "role": { -"description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project - 'roles/monitoring.viewer' applied on the shared VPC host project", +"description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project - 'roles/logging.admin' applied on the shared VPC host project - 'roles/monitoring.viewer' applied on the shared VPC host project - 'roles/servicemanagement.quotaViewer' applied on the shared VPC host project", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index 74b1fa01b06..b08f1ca68f3 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -29,6 +29,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://spanner.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://spanner.us-west1.rep.googleapis.com/", "location": "us-west1" } @@ -3259,7 +3264,7 @@ } } }, -"revision": "20240814", +"revision": "20240831", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index 6023f92d006..b130e3755f9 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -608,6 +608,73 @@ }, "instances": { "methods": { +"ListServerCertificates": { +"description": "Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.", +"flatPath": "v1/projects/{project}/instances/{instance}/listServerCertificates", +"httpMethod": "GET", +"id": "sql.instances.ListServerCertificates", +"parameterOrder": [ +"project", +"instance" +], +"parameters": { +"instance": { +"description": "Required. Cloud SQL instance ID. This does not include the project ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Required. Project ID of the project that contains the instance.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/projects/{project}/instances/{instance}/listServerCertificates", +"response": { +"$ref": "InstancesListServerCertificatesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/sqlservice.admin" +] +}, +"RotateServerCertificate": { +"description": "Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, please use RotateServerCa instead.", +"flatPath": "v1/projects/{project}/instances/{instance}/rotateServerCertificate", +"httpMethod": "POST", +"id": "sql.instances.RotateServerCertificate", +"parameterOrder": [ +"project", +"instance" +], +"parameters": { +"instance": { +"description": "Required. Cloud SQL instance ID. This does not include the project ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Required. Project ID of the project that contains the instance.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/projects/{project}/instances/{instance}/rotateServerCertificate", +"request": { +"$ref": "InstancesRotateServerCertificateRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/sqlservice.admin" +] +}, "acquireSsrsLease": { "description": "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", "flatPath": "v1/projects/{project}/instances/{instance}/acquireSsrsLease", @@ -675,6 +742,38 @@ "https://www.googleapis.com/auth/sqlservice.admin" ] }, +"addServerCertificate": { +"description": "Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, please use AddServerCa instead.", +"flatPath": "v1/projects/{project}/instances/{instance}/addServerCertificate", +"httpMethod": "POST", +"id": "sql.instances.addServerCertificate", +"parameterOrder": [ +"project", +"instance" +], +"parameters": { +"instance": { +"description": "Cloud SQL instance ID. This does not include the project ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID of the project that contains the instance.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/projects/{project}/instances/{instance}/addServerCertificate", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/sqlservice.admin" +] +}, "clone": { "description": "Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.", "flatPath": "v1/projects/{project}/instances/{instance}/clone", @@ -2267,7 +2366,7 @@ } } }, -"revision": "20240829", +"revision": "20240831", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -4454,6 +4553,35 @@ false }, "type": "object" }, +"InstancesListServerCertificatesResponse": { +"description": "Instances ListServerCertificates response.", +"id": "InstancesListServerCertificatesResponse", +"properties": { +"activeVersion": { +"description": "The `sha1_fingerprint` of the active certificate from `server_certs`.", +"type": "string" +}, +"caCerts": { +"description": "List of server CA certificates for the instance.", +"items": { +"$ref": "SslCert" +}, +"type": "array" +}, +"kind": { +"description": "This is always `sql#instancesListServerCertificates`.", +"type": "string" +}, +"serverCerts": { +"description": "List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list.", +"items": { +"$ref": "SslCert" +}, +"type": "array" +} +}, +"type": "object" +}, "InstancesReencryptRequest": { "description": "Database Instance reencrypt request.", "id": "InstancesReencryptRequest", @@ -4487,6 +4615,17 @@ false }, "type": "object" }, +"InstancesRotateServerCertificateRequest": { +"description": "Rotate server certificate request.", +"id": "InstancesRotateServerCertificateRequest", +"properties": { +"rotateServerCertificateContext": { +"$ref": "RotateServerCertificateContext", +"description": "Optional. Contains details about the rotate server certificate operation." +} +}, +"type": "object" +}, "InstancesTruncateLogRequest": { "description": "Instance truncate log request.", "id": "InstancesTruncateLogRequest", @@ -5314,6 +5453,21 @@ false }, "type": "object" }, +"RotateServerCertificateContext": { +"description": "Instance rotate server certificate context.", +"id": "RotateServerCertificateContext", +"properties": { +"kind": { +"description": "Optional. This is always `sql#rotateServerCertificateContext`.", +"type": "string" +}, +"nextVersion": { +"description": "The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.", +"type": "string" +} +}, +"type": "object" +}, "Settings": { "description": "Database instance settings.", "id": "Settings", @@ -5642,7 +5796,8 @@ true "EXTENSIONS_NOT_ENABLED_IN_REPLICA", "UNSUPPORTED_COLUMNS", "USERS_NOT_CREATED_IN_REPLICA", -"UNSUPPORTED_SYSTEM_OBJECTS" +"UNSUPPORTED_SYSTEM_OBJECTS", +"UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY" ], "enumDescriptions": [ "", @@ -5665,7 +5820,7 @@ true "The primary instance database parameter setup doesn't allow EM sync.", "The gtid_mode is not supported, applicable for MySQL.", "SQL Server Agent is not running.", -"The table definition is not support due to missing primary key or replica identity, applicable for postgres.", +"The table definition is not support due to missing primary key or replica identity, applicable for postgres. Note that this is a warning and won't block the migration.", "The customer has a definer that will break EM setup.", "SQL Server @@SERVERNAME does not match actual host name.", "The primary instance has been setup and will fail the setup.", @@ -5696,7 +5851,8 @@ true "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.", "The source database has users that aren't created in the replica. First, create all users, which are in the pg_user_mappings table of the source database, in the destination instance. Then, perform the migration.", -"The selected objects include system objects that aren't supported for migration." +"The selected objects include system objects that aren't supported for migration.", +"The source database has tables with the FULL or NOTHING replica identity. Before starting your migration, either remove the identity or change it to DEFAULT. Note that this is an error and will block the migration." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index 045b2b02103..c0cabcdc357 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -608,6 +608,73 @@ }, "instances": { "methods": { +"ListServerCertificates": { +"description": "Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.", +"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/listServerCertificates", +"httpMethod": "GET", +"id": "sql.instances.ListServerCertificates", +"parameterOrder": [ +"project", +"instance" +], +"parameters": { +"instance": { +"description": "Required. Cloud SQL instance ID. This does not include the project ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Required. Project ID of the project that contains the instance.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "sql/v1beta4/projects/{project}/instances/{instance}/listServerCertificates", +"response": { +"$ref": "InstancesListServerCertificatesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/sqlservice.admin" +] +}, +"RotateServerCertificate": { +"description": "Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, please use RotateServerCa instead.", +"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCertificate", +"httpMethod": "POST", +"id": "sql.instances.RotateServerCertificate", +"parameterOrder": [ +"project", +"instance" +], +"parameters": { +"instance": { +"description": "Required. Cloud SQL instance ID. This does not include the project ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Required. Project ID of the project that contains the instance.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCertificate", +"request": { +"$ref": "InstancesRotateServerCertificateRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/sqlservice.admin" +] +}, "acquireSsrsLease": { "description": "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/acquireSsrsLease", @@ -675,6 +742,38 @@ "https://www.googleapis.com/auth/sqlservice.admin" ] }, +"addServerCertificate": { +"description": "Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, please use AddServerCa instead.", +"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCertificate", +"httpMethod": "POST", +"id": "sql.instances.addServerCertificate", +"parameterOrder": [ +"project", +"instance" +], +"parameters": { +"instance": { +"description": "Required. Cloud SQL instance ID. This does not include the project ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Required. Project ID of the project that contains the instance.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCertificate", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/sqlservice.admin" +] +}, "clone": { "description": "Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/clone", @@ -2267,7 +2366,7 @@ } } }, -"revision": "20240829", +"revision": "20240831", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -4455,6 +4554,35 @@ false }, "type": "object" }, +"InstancesListServerCertificatesResponse": { +"description": "Instances ListServerCertificatess response.", +"id": "InstancesListServerCertificatesResponse", +"properties": { +"activeVersion": { +"description": "The `sha1_fingerprint` of the active certificate from `server_certs`.", +"type": "string" +}, +"caCerts": { +"description": "List of server CA certificates for the instance.", +"items": { +"$ref": "SslCert" +}, +"type": "array" +}, +"kind": { +"description": "This is always `sql#instancesListServerCertificates`.", +"type": "string" +}, +"serverCerts": { +"description": "List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list.", +"items": { +"$ref": "SslCert" +}, +"type": "array" +} +}, +"type": "object" +}, "InstancesReencryptRequest": { "description": "Database Instance reencrypt request.", "id": "InstancesReencryptRequest", @@ -4488,6 +4616,17 @@ false }, "type": "object" }, +"InstancesRotateServerCertificateRequest": { +"description": "Rotate Server Certificate request.", +"id": "InstancesRotateServerCertificateRequest", +"properties": { +"rotateServerCertificateContext": { +"$ref": "RotateServerCertificateContext", +"description": "Optional. Contains details about the rotate server CA operation." +} +}, +"type": "object" +}, "InstancesTruncateLogRequest": { "description": "Instance truncate log request.", "id": "InstancesTruncateLogRequest", @@ -5315,6 +5454,21 @@ false }, "type": "object" }, +"RotateServerCertificateContext": { +"description": "Instance rotate server certificate context.", +"id": "RotateServerCertificateContext", +"properties": { +"kind": { +"description": "Optional. This is always `sql#rotateServerCertificateContext`.", +"type": "string" +}, +"nextVersion": { +"description": "Optional. The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.", +"type": "string" +} +}, +"type": "object" +}, "Settings": { "description": "Database instance settings.", "id": "Settings", @@ -5643,7 +5797,8 @@ true "EXTENSIONS_NOT_ENABLED_IN_REPLICA", "UNSUPPORTED_COLUMNS", "USERS_NOT_CREATED_IN_REPLICA", -"UNSUPPORTED_SYSTEM_OBJECTS" +"UNSUPPORTED_SYSTEM_OBJECTS", +"UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY" ], "enumDescriptions": [ "", @@ -5666,7 +5821,7 @@ true "The primary instance database parameter setup doesn't allow EM sync.", "The gtid_mode is not supported, applicable for MySQL.", "SQL Server Agent is not running.", -"The table definition is not support due to missing primary key or replica identity, applicable for postgres.", +"The table definition is not support due to missing primary key or replica identity, applicable for postgres. Note that this is a warning and won't block the migration.", "The customer has a definer that will break EM setup.", "SQL Server @@SERVERNAME does not match actual host name.", "The primary instance has been setup and will fail the setup.", @@ -5697,7 +5852,8 @@ true "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.", "The source database has users that aren't created in the replica. First, create all users, which are in the pg_user_mappings table of the source database, in the destination instance. Then, perform the migration.", -"The selected objects include system objects that aren't supported for migration." +"The selected objects include system objects that aren't supported for migration.", +"The source database has tables with the FULL or NOTHING replica identity. Before starting your migration, either remove the identity or change it to DEFAULT. Note that this is an error and will block the migration." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/vision.v1.json b/googleapiclient/discovery_cache/documents/vision.v1.json index e7195b38389..67ea70abdad 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1.json @@ -1282,7 +1282,7 @@ } } }, -"revision": "20240621", +"revision": "20240823", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AddProductToProductSetRequest": { @@ -2748,7 +2748,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark", "properties": { "position": { @@ -4162,7 +4162,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark", "properties": { "position": { @@ -5611,7 +5611,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark", "properties": { "position": { @@ -7154,7 +7154,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark", "properties": { "position": { @@ -8322,7 +8322,7 @@ "type": "object" }, "Landmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "Landmark", "properties": { "position": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json b/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json index 8b81a975dd2..8af3ea5ba83 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json @@ -449,7 +449,7 @@ } } }, -"revision": "20240621", +"revision": "20240823", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { @@ -1856,7 +1856,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark", "properties": { "position": { @@ -3456,7 +3456,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark", "properties": { "position": { @@ -4905,7 +4905,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark", "properties": { "position": { @@ -6448,7 +6448,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark", "properties": { "position": { @@ -7518,7 +7518,7 @@ "type": "object" }, "Landmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "Landmark", "properties": { "position": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json b/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json index f61f0d0352d..f1107338425 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json @@ -449,7 +449,7 @@ } } }, -"revision": "20240621", +"revision": "20240823", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { @@ -1631,7 +1631,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark", "properties": { "position": { @@ -3270,7 +3270,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark", "properties": { "position": { @@ -4905,7 +4905,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark", "properties": { "position": { @@ -6448,7 +6448,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark", "properties": { "position": { @@ -7518,7 +7518,7 @@ "type": "object" }, "Landmark": { -"description": "A face-specific landmark (for example, a face feature).", +"description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "Landmark", "properties": { "position": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index 732663e3b7c..9024ce82852 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -517,7 +517,7 @@ } } }, -"revision": "20240813", +"revision": "20240827", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "Callback": { @@ -1009,13 +1009,15 @@ "STATE_UNSPECIFIED", "STATE_IN_PROGRESS", "STATE_SUCCEEDED", -"STATE_FAILED" +"STATE_FAILED", +"STATE_CANCELLED" ], "enumDescriptions": [ "Invalid state.", "The step entry is in progress.", "The step entry finished successfully.", -"The step entry failed with an error." +"The step entry failed with an error.", +"The step entry is cancelled." ], "readOnly": true, "type": "string" From 291d13c0287f95a686f5a90935e92849e5899043 Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Tue, 10 Sep 2024 13:40:13 -0700 Subject: [PATCH 2/2] chore(main): release 2.145.0 (#2480) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> --- CHANGELOG.md | 41 ++++++++++++++++++++++++++++++++++++++ googleapiclient/version.py | 2 +- 2 files changed, 42 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 67f5b4e3812..5cc898a08ac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,46 @@ # Changelog +## [2.145.0](https://github.com/googleapis/google-api-python-client/compare/v2.144.0...v2.145.0) (2024-09-10) + + +### Features + +* **aiplatform:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/b0e9b7088d0a9874dfd3fa76c2256c945ddfa5f4 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **alloydb:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/4248bcaae79888c7d2f598116c540d94ab295f5a ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **androidmanagement:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/9cd85f7ba60141ea19dd65190896a417ef0b1fbe ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **apigee:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/93f395ddde6e1c52e15ce006840f011b71418fec ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **artifactregistry:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ae7e87ba4ab148581cc3b79f0bf1846ee1ed3123 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **backupdr:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/c4fac8cd319b299aecc9d751e715877b54325365 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **baremetalsolution:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/d416775786ef684ee99946cb923d23dbfa50714b ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **chat:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/96b0c11f8fde539acf84538a91b3bc0248a80165 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **checks:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f6ac594b0d758bc999d982194f6bf1a1178e6024 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **cloudasset:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/c2fe812c59e334d32025a5453beca0343c60491f ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **compute:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/57a39ac8205dd44a8a4104f2e43a531eb3c9d90c ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **connectors:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/7722e6e017454a5a367a81247fe01a1854653b32 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **contactcenteraiplatform:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/5ea2f0bd58deb72d7f5fe5ebd0321178e4b429b6 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **containeranalysis:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/76f58d51386bfd92ef74db15a89d64142242a293 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **container:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/81dc9c948eb1d04a8328476d76f4168922009016 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **discoveryengine:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/88a5b5f17d5dd0642c9bf820b19c79d080fe7e45 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **dlp:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/8d4b2d2e9780e634f416d27cd508d9e1a9936bd9 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **drive:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/2ec82eefa3f0beab2ea3b782167cf4eeb1c9c67d ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **file:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/d81a62a6d9361e0c7105d190fca181d9f8ee0a51 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **gkehub:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/aa5e1571c5139293553159dc9a416ee0239f2000 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **healthcare:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/7eb47bf628eaa3566278c81803fa906a631e2882 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **integrations:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/3060536a781563e759bdf83608176f8465682318 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **logging:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/b784bf0186abbacd9b040ae4f42c465ab428c136 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **migrationcenter:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/7ccb8790fc04acbfe8e677c53b42e969c7416376 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **monitoring:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/da429bd49ae672d251a5d1e4972484f05dbcc684 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **networksecurity:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/baac341fa5fc8cc15176bf0ab83ffb9f3adfe306 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **redis:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/22f6a96c896e1af1cd8a0d49dc1bdb5458569024 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **run:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/52b287d546f7df0048880e1cb2451b1f84ea266a ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **sqladmin:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/1769e73def4dfc8daad50d7a19cc6a8d43ee6ba1 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) + + +### Bug Fixes + +* **cloudkms:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/960560970e66bcf40378467352894afc4b4c9101 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) +* **spanner:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/cf162c2c525054e0cdad889ca15fd9b5f29ae1d2 ([c695616](https://github.com/googleapis/google-api-python-client/commit/c695616b3f6f11887fd1a12119156909798d75bb)) + ## [2.144.0](https://github.com/googleapis/google-api-python-client/compare/v2.143.0...v2.144.0) (2024-09-03) diff --git a/googleapiclient/version.py b/googleapiclient/version.py index d02ba991be0..b701d0fc706 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.144.0" +__version__ = "2.145.0"