From f670c8f2acb4b5817434944d13d627ededa55c04 Mon Sep 17 00:00:00 2001 From: Amanda Tarafa Mas Date: Thu, 23 May 2024 01:19:27 -0700 Subject: [PATCH] Update discovery documents and generated code automatically_generated_update --- DiscoveryJson/admin_directory_v1.json | 2 +- DiscoveryJson/alloydb_v1.json | 94 +- DiscoveryJson/analyticsadmin_v1alpha.json | 12 +- DiscoveryJson/androidmanagement_v1.json | 29 +- DiscoveryJson/batch_v1.json | 14 +- DiscoveryJson/bigquery_v2.json | 4 +- DiscoveryJson/chat_v1.json | 12 +- DiscoveryJson/cloudbilling_v1.json | 14 +- DiscoveryJson/cloudbuild_v1.json | 4 +- DiscoveryJson/cloudbuild_v2.json | 36 +- DiscoveryJson/composer_v1.json | 41 +- DiscoveryJson/contactcenterinsights_v1.json | 4 +- DiscoveryJson/content_v2.1.json | 53 +- DiscoveryJson/discoveryengine_v1.json | 2023 ++- DiscoveryJson/discoveryengine_v1alpha.json | 110 +- DiscoveryJson/discoveryengine_v1beta.json | 106 +- DiscoveryJson/fcmdata_v1beta1.json | 50 +- DiscoveryJson/file_v1.json | 86 +- DiscoveryJson/firebaseml_v2beta.json | 6 +- DiscoveryJson/firestore_v1.json | 8 +- DiscoveryJson/gmail_v1.json | 32 +- DiscoveryJson/iam_v1.json | 130 +- DiscoveryJson/migrationcenter_v1.json | 4 +- DiscoveryJson/migrationcenter_v1alpha1.json | 4 +- DiscoveryJson/networkmanagement_v1.json | 68 +- DiscoveryJson/places_v1.json | 4 +- DiscoveryJson/recaptchaenterprise_v1.json | 48 +- DiscoveryJson/redis_v1.json | 34 +- DiscoveryJson/redis_v1beta1.json | 34 +- DiscoveryJson/servicenetworking_v1.json | 4 +- DiscoveryJson/servicenetworking_v1beta.json | 4 +- DiscoveryJson/sheets_v4.json | 4 +- DiscoveryJson/sourcerepo_v1.json | 6 +- DiscoveryJson/workstations_v1beta.json | 26 +- ...e.Apis.Admin.Directory.directory_v1.csproj | 2 +- .../Google.Apis.AndroidManagement.v1.cs | 28 +- .../Google.Apis.AndroidManagement.v1.csproj | 2 +- .../Google.Apis.Batch.v1.cs | 32 +- .../Google.Apis.Batch.v1.csproj | 2 +- .../Google.Apis.Bigquery.v2.cs | 5 +- .../Google.Apis.Bigquery.v2.csproj | 2 +- .../Google.Apis.CloudAlloyDBAdmin.v1.cs | 82 + .../Google.Apis.CloudAlloyDBAdmin.v1.csproj | 2 +- .../Google.Apis.CloudBuild.v1.cs | 2 +- .../Google.Apis.CloudBuild.v1.csproj | 2 +- .../Google.Apis.CloudBuild.v2.cs | 53 +- .../Google.Apis.CloudBuild.v2.csproj | 2 +- .../Google.Apis.CloudComposer.v1.cs | 90 + .../Google.Apis.CloudComposer.v1.csproj | 2 +- .../Google.Apis.CloudFilestore.v1.cs | 82 - .../Google.Apis.CloudFilestore.v1.csproj | 2 +- .../Google.Apis.CloudRedis.v1.csproj | 2 +- .../Google.Apis.CloudRedis.v1beta1.csproj | 2 +- ...gle.Apis.CloudSourceRepositories.v1.csproj | 4 +- .../Google.Apis.CloudWorkstations.v1beta.cs | 25 + ...oogle.Apis.CloudWorkstations.v1beta.csproj | 2 +- .../Google.Apis.Cloudbilling.v1.cs | 14 +- .../Google.Apis.Cloudbilling.v1.csproj | 2 +- .../Google.Apis.Contactcenterinsights.v1.cs | 7 +- ...oogle.Apis.Contactcenterinsights.v1.csproj | 2 +- .../Google.Apis.DiscoveryEngine.v1.cs | 11798 ++++++++++------ .../Google.Apis.DiscoveryEngine.v1.csproj | 2 +- .../Google.Apis.DiscoveryEngine.v1alpha.cs | 192 +- ...Google.Apis.DiscoveryEngine.v1alpha.csproj | 2 +- .../Google.Apis.DiscoveryEngine.v1beta.cs | 191 +- .../Google.Apis.DiscoveryEngine.v1beta.csproj | 2 +- .../Google.Apis.Fcmdata.v1beta1.cs | 67 +- .../Google.Apis.Fcmdata.v1beta1.csproj | 2 +- .../Google.Apis.FirebaseML.v2beta.cs | 9 + .../Google.Apis.FirebaseML.v2beta.csproj | 2 +- .../Google.Apis.Firestore.v1.cs | 13 +- .../Google.Apis.Firestore.v1.csproj | 2 +- .../Google.Apis.Gmail.v1.cs | 66 - .../Google.Apis.Gmail.v1.csproj | 2 +- ...oogle.Apis.GoogleAnalyticsAdmin.v1alpha.cs | 44 +- ...e.Apis.GoogleAnalyticsAdmin.v1alpha.csproj | 2 +- .../Google.Apis.HangoutsChat.v1.cs | 40 +- .../Google.Apis.HangoutsChat.v1.csproj | 2 +- .../Google.Apis.Iam.v1/Google.Apis.Iam.v1.cs | 478 +- .../Google.Apis.Iam.v1.csproj | 2 +- .../Google.Apis.MapsPlaces.v1.cs | 8 +- .../Google.Apis.MapsPlaces.v1.csproj | 2 +- .../Google.Apis.MigrationCenterAPI.v1.cs | 2 +- .../Google.Apis.MigrationCenterAPI.v1.csproj | 2 +- ...Google.Apis.MigrationCenterAPI.v1alpha1.cs | 2 +- ...le.Apis.MigrationCenterAPI.v1alpha1.csproj | 2 +- .../Google.Apis.NetworkManagement.v1.cs | 54 +- .../Google.Apis.NetworkManagement.v1.csproj | 2 +- .../Google.Apis.RecaptchaEnterprise.v1.cs | 35 + .../Google.Apis.RecaptchaEnterprise.v1.csproj | 2 +- .../Google.Apis.ServiceNetworking.v1.cs | 3 +- .../Google.Apis.ServiceNetworking.v1.csproj | 2 +- .../Google.Apis.ServiceNetworking.v1beta.cs | 3 +- ...oogle.Apis.ServiceNetworking.v1beta.csproj | 2 +- .../Google.Apis.Sheets.v4.cs | 2 +- .../Google.Apis.Sheets.v4.csproj | 2 +- .../Google.Apis.ShoppingContent.v2_1.cs | 109 +- .../Google.Apis.ShoppingContent.v2_1.csproj | 2 +- 98 files changed, 10787 insertions(+), 5929 deletions(-) diff --git a/DiscoveryJson/admin_directory_v1.json b/DiscoveryJson/admin_directory_v1.json index 557ffae459..1f8707ee8b 100644 --- a/DiscoveryJson/admin_directory_v1.json +++ b/DiscoveryJson/admin_directory_v1.json @@ -4671,7 +4671,7 @@ } } }, - "revision": "20240509", + "revision": "20240521", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/DiscoveryJson/alloydb_v1.json b/DiscoveryJson/alloydb_v1.json index 45b3f308b8..860f71b1db 100644 --- a/DiscoveryJson/alloydb_v1.json +++ b/DiscoveryJson/alloydb_v1.json @@ -1461,7 +1461,7 @@ } } }, - "revision": "20240424", + "revision": "20240517", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3246,10 +3246,13 @@ ], "type": "string" }, - "recommendationSignalData": { - "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData", + "observabilityMetricData": { + "$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", "description": "More feed data would be added in subsequent CLs" }, + "recommendationSignalData": { + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData" + }, "resourceHealthSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData" }, @@ -3423,7 +3426,11 @@ "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", - "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES", + "SIGNAL_TYPE_SUPERUSER_WRITING_TO_USER_TABLES", + "SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS", + "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", + "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET" ], "enumDeprecated": [ false, @@ -3492,6 +3499,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -3561,7 +3572,11 @@ "Performance impact of connections settings", "Performance impact of temporary tables settings", "Performance impact of transaction logs settings", - "Performance impact of high joins without indexes" + "Performance impact of high joins without indexes", + "Detects events where a Cloud SQL superuser (postgres for PostgreSQL servers or root for MySQL users) writes to non-system tables.", + "Detects events where a database user or role has been granted all privileges to a database, or to all tables, procedures, or functions in a schema.", + "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", + "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible." ], "type": "string" }, @@ -3744,6 +3759,10 @@ "description": "The resource location. REQUIRED", "type": "string" }, + "machineConfiguration": { + "$ref": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", + "description": "Machine configuration for this resource." + }, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." @@ -3902,7 +3921,11 @@ "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", - "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES", + "SIGNAL_TYPE_SUPERUSER_WRITING_TO_USER_TABLES", + "SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS", + "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", + "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET" ], "enumDeprecated": [ false, @@ -3971,6 +3994,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4040,7 +4067,11 @@ "Performance impact of connections settings", "Performance impact of temporary tables settings", "Performance impact of transaction logs settings", - "Performance impact of high joins without indexes" + "Performance impact of high joins without indexes", + "Detects events where a Cloud SQL superuser (postgres for PostgreSQL servers or root for MySQL users) writes to non-system tables.", + "Detects events where a database user or role has been granted all privileges to a database, or to all tables, procedures, or functions in a schema.", + "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", + "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible." ], "type": "string" } @@ -4080,6 +4111,55 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": { + "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", + "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", + "properties": { + "cpuCount": { + "description": "The number of CPUs.", + "format": "int32", + "type": "integer" + }, + "memorySizeInBytes": { + "description": "Memory size in bytes.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData": { + "id": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", + "properties": { + "metricTimestamp": { + "description": "Required. The timestamp of the metric value.", + "format": "google-datetime", + "type": "string" + }, + "metricType": { + "description": "Required. Type of metric like CPU, Memory, etc.", + "enum": [ + "METRIC_TYPE_UNSPECIFIED", + "INSTANCE_PEAK_CPU_UTILISATION" + ], + "enumDescriptions": [ + "", + "Peak CPU utilization for a DB instance as a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases) List will keep increasing, e.g. PEAK_MEMORY_UTILISATION, NUMBER_OF_CONNECTIONS, SUCCESS_RATIO_FOR_QUERIES, etc." + ], + "type": "string" + }, + "resourceName": { + "description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + }, + "value": { + "description": "Required. Value of the metric type.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainOperationError": { "description": "An error that occurred during a backup creation operation.", "id": "StorageDatabasecenterPartnerapiV1mainOperationError", diff --git a/DiscoveryJson/analyticsadmin_v1alpha.json b/DiscoveryJson/analyticsadmin_v1alpha.json index 2f9af348a9..f04fa0beec 100644 --- a/DiscoveryJson/analyticsadmin_v1alpha.json +++ b/DiscoveryJson/analyticsadmin_v1alpha.json @@ -4617,7 +4617,7 @@ } } }, - "revision": "20240402", + "revision": "20240521", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -5230,6 +5230,12 @@ "readOnly": true, "type": "boolean" }, + "createTime": { + "description": "Output only. Time when the Audience was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "description": { "description": "Required. The description of the Audience.", "type": "string" @@ -6384,10 +6390,6 @@ "description": "Request message for CreateSubproperty RPC.", "id": "GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest", "properties": { - "parent": { - "description": "Required. The ordinary property for which to create a subproperty. Format: properties/property_id Example: properties/123", - "type": "string" - }, "subproperty": { "$ref": "GoogleAnalyticsAdminV1alphaProperty", "description": "Required. The subproperty to create." diff --git a/DiscoveryJson/androidmanagement_v1.json b/DiscoveryJson/androidmanagement_v1.json index 17d07851bd..930994f062 100644 --- a/DiscoveryJson/androidmanagement_v1.json +++ b/DiscoveryJson/androidmanagement_v1.json @@ -1141,6 +1141,11 @@ "id": "androidmanagement.signupUrls.create", "parameterOrder": [], "parameters": { + "adminEmail": { + "description": "Optional. Email address used to prefill the admin field of the enterprise signup form. This value is a hint only and can be altered by the user.", + "location": "query", + "type": "string" + }, "callbackUrl": { "description": "The callback URL that the admin will be redirected to after successfully creating an enterprise. Before redirecting there the system will add a query parameter to this URL named enterpriseToken which will contain an opaque token to be used for the create enterprise request. The URL will be parsed then reformatted in order to add the enterpriseToken parameter, so there may be some minor formatting changes.", "location": "query", @@ -1163,7 +1168,7 @@ } } }, - "revision": "20240425", + "revision": "20240516", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1936,7 +1941,7 @@ "id": "BatchUsageLogEvents", "properties": { "device": { - "description": "The name of the device in the form \u2018enterprises/{enterpriseId}/devices/{deviceId}\u2019", + "description": "If present, the name of the device in the form \u2018enterprises/{enterpriseId}/devices/{deviceId}\u2019", "type": "string" }, "retrievalTime": { @@ -1952,7 +1957,7 @@ "type": "array" }, "user": { - "description": "The resource name of the user that owns this device in the form \u2018enterprises/{enterpriseId}/users/{userId}\u2019.", + "description": "If present, the resource name of the user that owns this device in the form \u2018enterprises/{enterpriseId}/users/{userId}\u2019.", "type": "string" } }, @@ -2470,7 +2475,8 @@ "DELETED", "PROVISIONING", "LOST", - "PREPARING_FOR_MIGRATION" + "PREPARING_FOR_MIGRATION", + "DEACTIVATED_BY_DEVICE_FINANCE" ], "enumDescriptions": [ "This value is disallowed.", @@ -2479,7 +2485,8 @@ "The device was deleted. This state is never returned by an API call, but is used in the final status report when the device acknowledges the deletion. If the device is deleted via the API call, this state is published to Pub/Sub. If the user deletes the work profile or resets the device, the device state will remain unknown to the server.", "The device is being provisioned. Newly enrolled devices are in this state until they have a policy applied.", "The device is lost. This state is only possible on organization-owned devices.", - "The device is preparing for migrating to Android Management API. No further action is needed for the migration to continue." + "The device is preparing for migrating to Android Management API. No further action is needed for the migration to continue.", + "This is a financed device that has been \"locked\" by the financing agent. This means certain policy settings have been applied which limit device functionality until the device has been \"unlocked\" by the financing agent. The device will continue to apply policy settings excluding those overridden by the financing agent. When the device is \"locked\", the state is reported in appliedState as DEACTIVATED_BY_DEVICE_FINANCE." ], "type": "string" }, @@ -2640,7 +2647,8 @@ "DELETED", "PROVISIONING", "LOST", - "PREPARING_FOR_MIGRATION" + "PREPARING_FOR_MIGRATION", + "DEACTIVATED_BY_DEVICE_FINANCE" ], "enumDescriptions": [ "This value is disallowed.", @@ -2649,7 +2657,8 @@ "The device was deleted. This state is never returned by an API call, but is used in the final status report when the device acknowledges the deletion. If the device is deleted via the API call, this state is published to Pub/Sub. If the user deletes the work profile or resets the device, the device state will remain unknown to the server.", "The device is being provisioned. Newly enrolled devices are in this state until they have a policy applied.", "The device is lost. This state is only possible on organization-owned devices.", - "The device is preparing for migrating to Android Management API. No further action is needed for the migration to continue." + "The device is preparing for migrating to Android Management API. No further action is needed for the migration to continue.", + "This is a financed device that has been \"locked\" by the financing agent. This means certain policy settings have been applied which limit device functionality until the device has been \"unlocked\" by the financing agent. The device will continue to apply policy settings excluding those overridden by the financing agent. When the device is \"locked\", the state is reported in appliedState as DEACTIVATED_BY_DEVICE_FINANCE." ], "type": "string" }, @@ -5456,7 +5465,7 @@ "type": "string" }, "imei": { - "description": "IMEI number of the GSM device. For example, A1000031212.", + "description": "For corporate-owned devices, IMEI number of the GSM device. For example, A1000031212.", "type": "string" }, "managementMode": { @@ -5474,7 +5483,7 @@ "type": "string" }, "meid": { - "description": "MEID number of the CDMA device. For example, A00000292788E1.", + "description": "For corporate-owned devices, MEID number of the CDMA device. For example, A00000292788E1.", "type": "string" }, "model": { @@ -5500,7 +5509,7 @@ "type": "string" }, "serialNumber": { - "description": "The device serial number.", + "description": "For corporate-owned devices, The device serial number.", "type": "string" } }, diff --git a/DiscoveryJson/batch_v1.json b/DiscoveryJson/batch_v1.json index ab6d05a828..7c004408d7 100644 --- a/DiscoveryJson/batch_v1.json +++ b/DiscoveryJson/batch_v1.json @@ -561,7 +561,7 @@ } } }, - "revision": "20240425", + "revision": "20240517", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -751,6 +751,10 @@ "description": "If the GCP instance has received preemption notice.", "type": "boolean" }, + "machineType": { + "description": "Optional. machine type of the VM", + "type": "string" + }, "osRelease": { "additionalProperties": { "type": "string" @@ -907,7 +911,7 @@ "description": "Environment variables to set before running the Task." }, "maxRunDuration": { - "description": "Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. The valid value range for max_run_duration in seconds is [0, 315576000000.999999999],", + "description": "Maximum duration the task should run before being automatically retried (if enabled) or automatically failed. Format the value of this field as a time limit in seconds followed by `s`\u2014for example, `3600s` for 1 hour. The field accepts any value between 0 and the maximum listed for the `Duration` field type at https://protobuf.dev/reference/protobuf/google.protobuf/#duration; however, the actual maximum run time for a job will be limited to the maximum run time for a job listed at https://cloud.google.com/batch/quotas#max-job-duration.", "format": "google-duration", "type": "string" }, @@ -1253,7 +1257,7 @@ "id": "InstancePolicyOrTemplate", "properties": { "installGpuDrivers": { - "description": "Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.", + "description": "Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in `policy.accelerators` or `instance_template` on your behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.", "type": "boolean" }, "instanceTemplate": { @@ -2067,7 +2071,7 @@ "id": "TaskExecution", "properties": { "exitCode": { - "description": "The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: - Batch known failures as https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. - Batch runnable execution failures: You can rely on Batch logs for further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error caught for now.", + "description": "The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error.", "format": "int32", "type": "integer" } @@ -2193,7 +2197,7 @@ "type": "integer" }, "maxRunDuration": { - "description": "Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. The valid value range for max_run_duration in seconds is [0, 315576000000.999999999],", + "description": "Maximum duration the task should run before being automatically retried (if enabled) or automatically failed. Format the value of this field as a time limit in seconds followed by `s`\u2014for example, `3600s` for 1 hour. The field accepts any value between 0 and the maximum listed for the `Duration` field type at https://protobuf.dev/reference/protobuf/google.protobuf/#duration; however, the actual maximum run time for a job will be limited to the maximum run time for a job listed at https://cloud.google.com/batch/quotas#max-job-duration.", "format": "google-duration", "type": "string" }, diff --git a/DiscoveryJson/bigquery_v2.json b/DiscoveryJson/bigquery_v2.json index 6004346a58..1002e212e3 100644 --- a/DiscoveryJson/bigquery_v2.json +++ b/DiscoveryJson/bigquery_v2.json @@ -1935,7 +1935,7 @@ } } }, - "revision": "20240423", + "revision": "20240418", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -9006,7 +9006,7 @@ "readOnly": true }, "replicationIntervalMs": { - "description": "Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not specified, default replication interval would be applied.", + "description": "Required. Specifies the interval at which the source table is polled for updates.", "format": "int64", "type": "string" }, diff --git a/DiscoveryJson/chat_v1.json b/DiscoveryJson/chat_v1.json index aec435c47e..18511c2dcb 100644 --- a/DiscoveryJson/chat_v1.json +++ b/DiscoveryJson/chat_v1.json @@ -347,7 +347,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the space, in the form \"spaces/*\". Format: `spaces/{space}`", + "description": "Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}`", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -365,7 +365,7 @@ ] }, "list": { - "description": "Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. ", + "description": "Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the `spaces.search()` method using Workspace administrator privileges instead.", "flatPath": "v1/spaces", "httpMethod": "GET", "id": "chat.spaces.list", @@ -550,7 +550,7 @@ ], "parameters": { "filter": { - "description": "Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. For example, the following queries are valid: ``` role = \"ROLE_MANAGER\" OR role = \"ROLE_MEMBER\" member.type = \"HUMAN\" AND role = \"ROLE_MANAGER\" ``` The following queries are invalid: ``` member.type = \"HUMAN\" AND member.type = \"BOT\" role = \"ROLE_MANAGER\" AND role = \"ROLE_MEMBER\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.", + "description": "Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. Developer Preview: You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = \"HUMAN\"` or `member.type != \"BOT\"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = \"ROLE_MANAGER\" OR role = \"ROLE_MEMBER\" member.type = \"HUMAN\" AND role = \"ROLE_MANAGER\" member.type != \"BOT\" ``` The following queries are invalid: ``` member.type = \"HUMAN\" AND member.type = \"BOT\" role = \"ROLE_MANAGER\" AND role = \"ROLE_MEMBER\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.", "location": "query", "type": "string" }, @@ -903,7 +903,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.", + "description": "Required. Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.", "location": "path", "pattern": "^spaces/[^/]+/messages/[^/]+/attachments/[^/]+$", "required": true, @@ -1215,7 +1215,7 @@ } } }, - "revision": "20240509", + "revision": "20240519", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessoryWidget": { @@ -1424,7 +1424,7 @@ "readOnly": true }, "name": { - "description": "Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`.", + "description": "Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.", "type": "string" }, "source": { diff --git a/DiscoveryJson/cloudbilling_v1.json b/DiscoveryJson/cloudbilling_v1.json index 601df47eb4..cf2026bc98 100644 --- a/DiscoveryJson/cloudbilling_v1.json +++ b/DiscoveryJson/cloudbilling_v1.json @@ -723,7 +723,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the service. Example: \"services/DA34-426B-A397\"", + "description": "Required. The name of the service. Example: \"services/6F81-5844-456A\"", "location": "path", "pattern": "^services/[^/]+$", "required": true, @@ -751,7 +751,7 @@ } } }, - "revision": "20240119", + "revision": "20240517", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "AggregationInfo": { @@ -1211,11 +1211,11 @@ "type": "string" }, "name": { - "description": "The resource name for the service. Example: \"services/DA34-426B-A397\"", + "description": "The resource name for the service. Example: \"services/6F81-5844-456A\"", "type": "string" }, "serviceId": { - "description": "The identifier for the service. Example: \"DA34-426B-A397\"", + "description": "The identifier for the service. Example: \"6F81-5844-456A\"", "type": "string" } }, @@ -1238,7 +1238,7 @@ "type": "object" }, "Sku": { - "description": "Encapsulates a single SKU in Google Cloud Platform", + "description": "Encapsulates a single SKU in Google Cloud", "id": "Sku", "properties": { "category": { @@ -1254,7 +1254,7 @@ "description": "The geographic taxonomy for this sku." }, "name": { - "description": "The resource name for the SKU. Example: \"services/DA34-426B-A397/skus/AA95-CD31-42FE\"", + "description": "The resource name for the SKU. Example: \"services/6F81-5844-456A/skus/D041-B8A1-6E0B\"", "type": "string" }, "pricingInfo": { @@ -1276,7 +1276,7 @@ "type": "array" }, "skuId": { - "description": "The identifier for the SKU. Example: \"AA95-CD31-42FE\"", + "description": "The identifier for the SKU. Example: \"D041-B8A1-6E0B\"", "type": "string" } }, diff --git a/DiscoveryJson/cloudbuild_v1.json b/DiscoveryJson/cloudbuild_v1.json index 00af84742a..773391e9af 100644 --- a/DiscoveryJson/cloudbuild_v1.json +++ b/DiscoveryJson/cloudbuild_v1.json @@ -2346,7 +2346,7 @@ } } }, - "revision": "20240512", + "revision": "20240519", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -3026,7 +3026,7 @@ "type": "string" }, "diskSizeGb": { - "description": "Requested disk size for the VM that runs the build. Note that this is *NOT* \"disk free\"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 2000GB; builds that request more than the maximum are rejected with an error.", + "description": "Requested disk size for the VM that runs the build. Note that this is *NOT* \"disk free\"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error.", "format": "int64", "type": "string" }, diff --git a/DiscoveryJson/cloudbuild_v2.json b/DiscoveryJson/cloudbuild_v2.json index 97f8cb92d6..6beb110758 100644 --- a/DiscoveryJson/cloudbuild_v2.json +++ b/DiscoveryJson/cloudbuild_v2.json @@ -844,7 +844,7 @@ } } }, - "revision": "20240427", + "revision": "20240519", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { @@ -977,7 +977,7 @@ "description": "Required. A http access token with the `REPO_ADMIN` scope access." }, "hostUri": { - "description": "Required. The URI of the Bitbucket Data Center instance or cluster this connection is for.", + "description": "Optional. The URI of the Bitbucket Data Center instance or cluster this connection is for.", "type": "string" }, "readAuthorizerCredential": { @@ -1074,7 +1074,7 @@ "additionalProperties": { "type": "string" }, - "description": "Allows clients to store small amounts of arbitrary data.", + "description": "Optional. Allows clients to store small amounts of arbitrary data.", "type": "object" }, "bitbucketCloudConfig": { @@ -1092,7 +1092,7 @@ "type": "string" }, "disabled": { - "description": "If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.", + "description": "Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.", "type": "boolean" }, "etag": { @@ -1320,13 +1320,13 @@ "id": "GitHubConfig", "properties": { "appInstallationId": { - "description": "GitHub App installation id.", + "description": "Optional. GitHub App installation id.", "format": "int64", "type": "string" }, "authorizerCredential": { "$ref": "OAuthCredential", - "description": "OAuth credential of the account that authorized the Cloud Build GitHub App. It is recommended to use a robot account instead of a human user account. The OAuth token must be tied to the Cloud Build GitHub App." + "description": "Optional. OAuth credential of the account that authorized the Cloud Build GitHub App. It is recommended to use a robot account instead of a human user account. The OAuth token must be tied to the Cloud Build GitHub App." } }, "type": "object" @@ -1392,17 +1392,17 @@ "type": "string" }, "appId": { - "description": "Id of the GitHub App created from the manifest.", + "description": "Optional. Id of the GitHub App created from the manifest.", "format": "int64", "type": "string" }, "appInstallationId": { - "description": "ID of the installation of the GitHub App.", + "description": "Optional. ID of the installation of the GitHub App.", "format": "int64", "type": "string" }, "appSlug": { - "description": "The URL-friendly name of the GitHub App.", + "description": "Optional. The URL-friendly name of the GitHub App.", "type": "string" }, "hostUri": { @@ -1410,7 +1410,7 @@ "type": "string" }, "privateKeySecretVersion": { - "description": "SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.", + "description": "Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.", "type": "string" }, "serverVersion": { @@ -1420,14 +1420,14 @@ }, "serviceDirectoryConfig": { "$ref": "GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig", - "description": "Configuration for using Service Directory to privately connect to a GitHub Enterprise server. This should only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitHub Enterprise server will be made over the public internet." + "description": "Optional. Configuration for using Service Directory to privately connect to a GitHub Enterprise server. This should only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitHub Enterprise server will be made over the public internet." }, "sslCa": { - "description": "SSL certificate to use for requests to GitHub Enterprise.", + "description": "Optional. SSL certificate to use for requests to GitHub Enterprise.", "type": "string" }, "webhookSecretSecretVersion": { - "description": "SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.", + "description": "Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.", "type": "string" } }, @@ -1442,7 +1442,7 @@ "description": "Required. A GitLab personal access token with the `api` scope access." }, "hostUri": { - "description": "The URI of the GitLab Enterprise host this connection is for. If not specified, the default value is https://gitlab.com.", + "description": "Optional. The URI of the GitLab Enterprise host this connection is for. If not specified, the default value is https://gitlab.com.", "type": "string" }, "readAuthorizerCredential": { @@ -1456,10 +1456,10 @@ }, "serviceDirectoryConfig": { "$ref": "GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig", - "description": "Configuration for using Service Directory to privately connect to a GitLab Enterprise server. This should only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitLab Enterprise server will be made over the public internet." + "description": "Optional. Configuration for using Service Directory to privately connect to a GitLab Enterprise server. This should only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitLab Enterprise server will be made over the public internet." }, "sslCa": { - "description": "SSL certificate to use for requests to GitLab Enterprise.", + "description": "Optional. SSL certificate to use for requests to GitLab Enterprise.", "type": "string" }, "webhookSecretSecretVersion": { @@ -1680,7 +1680,7 @@ "id": "OAuthCredential", "properties": { "oauthTokenSecretVersion": { - "description": "A SecretManager resource containing the OAuth token that authorizes the Cloud Build connection. Format: `projects/*/secrets/*/versions/*`.", + "description": "Optional. A SecretManager resource containing the OAuth token that authorizes the Cloud Build connection. Format: `projects/*/secrets/*/versions/*`.", "type": "string" }, "username": { @@ -2370,7 +2370,7 @@ "additionalProperties": { "type": "string" }, - "description": "Allows clients to store small amounts of arbitrary data.", + "description": "Optional. Allows clients to store small amounts of arbitrary data.", "type": "object" }, "createTime": { diff --git a/DiscoveryJson/composer_v1.json b/DiscoveryJson/composer_v1.json index 0465e2a103..debcf1f784 100644 --- a/DiscoveryJson/composer_v1.json +++ b/DiscoveryJson/composer_v1.json @@ -111,6 +111,34 @@ "resources": { "environments": { "methods": { + "checkUpgrade": { + "description": "Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:checkUpgrade", + "httpMethod": "POST", + "id": "composer.projects.locations.environments.checkUpgrade", + "parameterOrder": [ + "environment" + ], + "parameters": { + "environment": { + "description": "Required. The resource name of the environment to check upgrade for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+environment}:checkUpgrade", + "request": { + "$ref": "CheckUpgradeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Create a new environment.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments", @@ -938,7 +966,7 @@ } } }, - "revision": "20240317", + "revision": "20240520", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -982,6 +1010,17 @@ }, "type": "object" }, + "CheckUpgradeRequest": { + "description": "Request to check whether image upgrade will succeed.", + "id": "CheckUpgradeRequest", + "properties": { + "imageVersion": { + "description": "Optional. The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+(\\.[0-9]+\\.[0-9]+(-preview\\.[0-9]+)?)?|latest)-airflow-([0-9]+(\\.[0-9]+(\\.[0-9]+)?)?)`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the image version is a full [semantic version](https://semver.org), or an alias in the form of major version number or `latest`. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also [version list](/composer/docs/concepts/versioning/composer-versions) and [versioning overview](/composer/docs/concepts/versioning/composer-versioning-overview).", + "type": "string" + } + }, + "type": "object" + }, "CheckUpgradeResponse": { "description": "Message containing information about the result of an upgrade check operation.", "id": "CheckUpgradeResponse", diff --git a/DiscoveryJson/contactcenterinsights_v1.json b/DiscoveryJson/contactcenterinsights_v1.json index dda920e636..c68b7b0fdc 100644 --- a/DiscoveryJson/contactcenterinsights_v1.json +++ b/DiscoveryJson/contactcenterinsights_v1.json @@ -468,7 +468,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields to be updated.", + "description": "The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1474,7 +1474,7 @@ } } }, - "revision": "20240506", + "revision": "20240520", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1AgentCoachingInstruction": { diff --git a/DiscoveryJson/content_v2.1.json b/DiscoveryJson/content_v2.1.json index 31d4cab44f..93307dde4a 100644 --- a/DiscoveryJson/content_v2.1.json +++ b/DiscoveryJson/content_v2.1.json @@ -6219,7 +6219,7 @@ } } }, - "revision": "20240514", + "revision": "20240521", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -10988,12 +10988,12 @@ "id": "Metrics", "properties": { "aos": { - "description": "Average order size - the average number of items in an order. **This metric cannot be segmented by product dimensions and customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average order size - the average number of items in an order. **This metric cannot be segmented by product dimensions and customer_country_code.**", "format": "double", "type": "number" }, "aovMicros": { - "description": "Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by product dimensions and customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by product dimensions and customer_country_code.**", "format": "double", "type": "number" }, @@ -11003,17 +11003,17 @@ "type": "string" }, "conversionRate": { - "description": "Number of conversions divided by the number of clicks, reported on the impression date. The metric is currently available only for the FREE_PRODUCT_LISTING program.", + "description": "Number of conversions divided by the number of clicks, reported on the impression date. The metric is currently available only for the `FREE_PRODUCT_LISTING` program.", "format": "double", "type": "number" }, "conversionValueMicros": { - "description": "Value of conversions in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) attributed to the product, reported on the conversion date. The metric is currently available only for the FREE_PRODUCT_LISTING program. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response.", + "description": "Value of conversions in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) attributed to the product, reported on the conversion date. The metric is currently available only for the `FREE_PRODUCT_LISTING` program. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response.", "format": "int64", "type": "string" }, "conversions": { - "description": "Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. The metric is currently available only for the FREE_PRODUCT_LISTING program.", + "description": "Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. The metric is currently available only for the `FREE_PRODUCT_LISTING` program.", "format": "double", "type": "number" }, @@ -11023,7 +11023,7 @@ "type": "number" }, "daysToShip": { - "description": "Average number of days between an order being placed and the order being fully shipped, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average number of days between an order being placed and the order being fully shipped, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.**", "format": "double", "type": "number" }, @@ -11033,72 +11033,72 @@ "type": "string" }, "itemDaysToShip": { - "description": "Average number of days between an item being ordered and the item being **This metric cannot be segmented by customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average number of days between an item being ordered and the item being **This metric cannot be segmented by customer_country_code.**", "format": "double", "type": "number" }, "itemFillRate": { - "description": "Percentage of shipped items in relation to all finalized items (shipped or rejected by the merchant; unshipped items are not taken into account), reported on the order date. Item fill rate is lowered by merchant rejections. **This metric cannot be segmented by customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Percentage of shipped items in relation to all finalized items (shipped or rejected by the merchant; unshipped items are not taken into account), reported on the order date. Item fill rate is lowered by merchant rejections. **This metric cannot be segmented by customer_country_code.**", "format": "double", "type": "number" }, "orderedItemSalesMicros": { - "description": "Total price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", "format": "int64", "type": "string" }, "orderedItems": { - "description": "Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by customer_country_code.**", "format": "int64", "type": "string" }, "orders": { - "description": "Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by product dimensions and customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by product dimensions and customer_country_code.**", "format": "int64", "type": "string" }, "rejectedItems": { - "description": "Number of ordered items canceled by the merchant, reported on the order date. **This metric cannot be segmented by customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items canceled by the merchant, reported on the order date. **This metric cannot be segmented by customer_country_code.**", "format": "int64", "type": "string" }, "returnRate": { - "description": "Total price of returned items divided by the total price of shipped items, reported on the order date. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of returned items divided by the total price of shipped items, reported on the order date. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", "format": "double", "type": "number" }, "returnedItems": { - "description": "Number of ordered items sent back for return, reported on the date when the merchant accepted the return. **This metric cannot be segmented by customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items sent back for return, reported on the date when the merchant accepted the return. **This metric cannot be segmented by customer_country_code.**", "format": "int64", "type": "string" }, "returnsMicros": { - "description": "Total price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", "format": "int64", "type": "string" }, "shippedItemSalesMicros": { - "description": "Total price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**", "format": "int64", "type": "string" }, "shippedItems": { - "description": "Number of shipped items, reported on the shipment date. **This metric cannot be segmented by customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of shipped items, reported on the shipment date. **This metric cannot be segmented by customer_country_code.**", "format": "int64", "type": "string" }, "shippedOrders": { - "description": "Number of fully shipped orders, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of fully shipped orders, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.**", "format": "int64", "type": "string" }, "unshippedItems": { - "description": "Number of ordered items not shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped items over the days in the queried period. **This metric cannot be segmented by customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items not shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped items over the days in the queried period. **This metric cannot be segmented by customer_country_code.**", "format": "double", "type": "number" }, "unshippedOrders": { - "description": "Number of orders not shipped or partially shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped orders over the days in the queried period. **This metric cannot be segmented by product dimensions and customer_country_code.**", + "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of orders not shipped or partially shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped orders over the days in the queried period. **This metric cannot be segmented by product dimensions and customer_country_code.**", "format": "double", "type": "number" } @@ -14317,7 +14317,14 @@ }, "loyaltyProgram": { "$ref": "LoyaltyProgram", - "description": "Loyalty program information that is used to surface loyalty benefits ( for example pricing, points, etc) to the user for this item." + "description": "Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' field below." + }, + "loyaltyPrograms": { + "description": "Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.", + "items": { + "$ref": "LoyaltyProgram" + }, + "type": "array" }, "material": { "description": "The material of which the item is made.", @@ -17470,7 +17477,7 @@ "Shopping Ads.", "Free Product Listing.", "Free Local Product Listing.", - "Buy on Google Listing." + "*Deprecated*: This value is no longer supported. Retrieving all metrics for the `BUY_ON_GOOGLE_LISTING` program returns 0 starting from May 2024. Buy on Google Listing." ], "type": "string" }, diff --git a/DiscoveryJson/discoveryengine_v1.json b/DiscoveryJson/discoveryengine_v1.json index b25d0e414b..da3b6f96fb 100644 --- a/DiscoveryJson/discoveryengine_v1.json +++ b/DiscoveryJson/discoveryengine_v1.json @@ -436,7 +436,7 @@ ], "parameters": { "documentId": { - "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, @@ -510,7 +510,7 @@ ] }, "import": { - "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.", + "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.import", @@ -547,7 +547,7 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" @@ -583,7 +583,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Document is not found, a new Document will be created.", + "description": "If set to `true` and the Document is not found, a new Document is be created.", "location": "query", "type": "boolean" }, @@ -595,7 +595,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.", + "description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1095,7 +1095,7 @@ "type": "string" }, "schemaId": { - "description": "Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", + "description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "location": "query", "type": "string" } @@ -1171,7 +1171,7 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1207,7 +1207,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.", + "description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" }, @@ -1306,6 +1306,34 @@ }, "servingConfigs": { "methods": { + "answer": { + "description": "Answer query method.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer", + "parameterOrder": [ + "servingConfig" + ], + "parameters": { + "servingConfig": { + "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+servingConfig}:answer", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "recommend": { "description": "Makes a recommendation, which requires a contextual user event.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend", @@ -1316,7 +1344,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", + "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -1364,6 +1392,199 @@ } } }, + "sessions": { + "methods": { + "create": { + "description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.sessions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sessions", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.collections.dataStores.sessions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.sessions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all Sessions by their parent DataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.sessions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sessions", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListSessionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.collections.dataStores.sessions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "answers": { + "methods": { + "get": { + "description": "Gets a Answer.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.sessions.answers.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Answer" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "siteSearchEngine": { "methods": { "batchVerifyTargetSites": { @@ -1938,7 +2159,7 @@ ] }, "import": { - "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", + "description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.import", @@ -2421,6 +2642,34 @@ }, "servingConfigs": { "methods": { + "answer": { + "description": "Answer query method.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:answer", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.answer", + "parameterOrder": [ + "servingConfig" + ], + "parameters": { + "servingConfig": { + "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+servingConfig}:answer", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "recommend": { "description": "Makes a recommendation, which requires a contextual user event.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend", @@ -2431,7 +2680,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", + "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -2478,70 +2727,263 @@ ] } } - } - } - }, - "operations": { - "methods": { - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.collections.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.collections.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}/operations", + "sessions": { + "methods": { + "create": { + "description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.sessions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sessions", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.collections.engines.sessions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.sessions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all Sessions by their parent DataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.sessions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sessions", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListSessionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.collections.engines.sessions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "answers": { + "methods": { + "get": { + "description": "Gets a Answer.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.sessions.answers.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Answer" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, @@ -2804,7 +3246,7 @@ ], "parameters": { "documentId": { - "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, @@ -2878,7 +3320,7 @@ ] }, "import": { - "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.", + "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.dataStores.branches.documents.import", @@ -2915,7 +3357,7 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" @@ -2951,7 +3393,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Document is not found, a new Document will be created.", + "description": "If set to `true` and the Document is not found, a new Document is be created.", "location": "query", "type": "boolean" }, @@ -2963,7 +3405,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.", + "description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3463,7 +3905,7 @@ "type": "string" }, "schemaId": { - "description": "Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", + "description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "location": "query", "type": "string" } @@ -3539,7 +3981,7 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.", "format": "int32", "location": "query", "type": "integer" @@ -3575,7 +4017,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.", + "description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" }, @@ -3602,6 +4044,34 @@ }, "servingConfigs": { "methods": { + "answer": { + "description": "Answer query method.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.dataStores.servingConfigs.answer", + "parameterOrder": [ + "servingConfig" + ], + "parameters": { + "servingConfig": { + "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+servingConfig}:answer", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "recommend": { "description": "Makes a recommendation, which requires a contextual user event.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend", @@ -3612,7 +4082,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", + "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -3660,39 +4130,232 @@ } } }, - "siteSearchEngine": { + "sessions": { "methods": { - "disableAdvancedSiteSearch": { - "description": "Downgrade from advanced site search to basic site search.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch", + "create": { + "description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions", "httpMethod": "POST", - "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch", + "id": "discoveryengine.projects.locations.dataStores.sessions.create", "parameterOrder": [ - "siteSearchEngine" + "parent" ], "parameters": { - "siteSearchEngine": { - "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", + "parent": { + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+siteSearchEngine}:disableAdvancedSiteSearch", + "path": "v1/{+parent}/sessions", "request": { - "$ref": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest" + "$ref": "GoogleCloudDiscoveryengineV1Session" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudDiscoveryengineV1Session" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "enableAdvancedSiteSearch": { - "description": "Upgrade from basic site search to advanced site search.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch", + "delete": { + "description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.dataStores.sessions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.sessions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all Sessions by their parent DataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.sessions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sessions", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListSessionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.dataStores.sessions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "answers": { + "methods": { + "get": { + "description": "Gets a Answer.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.sessions.answers.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Answer" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "siteSearchEngine": { + "methods": { + "disableAdvancedSiteSearch": { + "description": "Downgrade from advanced site search to basic site search.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch", + "parameterOrder": [ + "siteSearchEngine" + ], + "parameters": { + "siteSearchEngine": { + "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+siteSearchEngine}:disableAdvancedSiteSearch", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "enableAdvancedSiteSearch": { + "description": "Upgrade from basic site search to advanced site search.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch", "httpMethod": "POST", "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch", "parameterOrder": [ @@ -4028,7 +4691,7 @@ ] }, "import": { - "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", + "description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.dataStores.userEvents.import", @@ -4189,6 +4852,38 @@ } } }, + "rankingConfigs": { + "methods": { + "rank": { + "description": "Ranks a list of text records based on the given input query.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rankingConfigs/{rankingConfigsId}:rank", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.rankingConfigs.rank", + "parameterOrder": [ + "rankingConfig" + ], + "parameters": { + "rankingConfig": { + "description": "Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/rankingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+rankingConfig}:rank", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1RankRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1RankResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "userEvents": { "methods": { "write": { @@ -4324,7 +5019,7 @@ } } }, - "revision": "20240512", + "revision": "20240517", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4362,112 +5057,885 @@ "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", "description": "The HTTP request which was processed when the error was triggered." }, - "reportLocation": { - "$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", - "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." + "reportLocation": { + "$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingErrorLog": { + "description": "An error log which is reported to the Error Reporting system.", + "id": "GoogleCloudDiscoveryengineLoggingErrorLog", + "properties": { + "context": { + "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", + "description": "A description of the context in which the error occurred." + }, + "importPayload": { + "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "description": "The error payload that is populated on LRO import APIs." + }, + "message": { + "description": "A message describing the error.", + "type": "string" + }, + "requestPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The API request payload, represented as a protocol buffer. Most API request types are supported\u2014for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", + "type": "object" + }, + "responsePayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", + "type": "object" + }, + "serviceContext": { + "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", + "description": "The service context in which this error has occurred." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The RPC status associated with the error log." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { + "description": "HTTP request data that is related to a reported error.", + "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "properties": { + "responseStatusCode": { + "description": "The HTTP response status code for the request.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingImportErrorContext": { + "description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", + "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "properties": { + "document": { + "description": "The detailed content which caused the error on importing a document.", + "type": "string" + }, + "gcsPath": { + "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", + "type": "string" + }, + "lineNumber": { + "description": "Line number of the content in file. Should be empty for permission or batch operation error.", + "type": "string" + }, + "operation": { + "description": "The operation resource name of the LRO.", + "type": "string" + }, + "userEvent": { + "description": "The detailed content which caused the error on importing a user event.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingServiceContext": { + "description": "Describes a running service that sends errors.", + "id": "GoogleCloudDiscoveryengineLoggingServiceContext", + "properties": { + "service": { + "description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingSourceLocation": { + "description": "Indicates a location in the source code of the service for which errors are reported.", + "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "properties": { + "functionName": { + "description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Answer": { + "description": "Defines an answer.", + "id": "GoogleCloudDiscoveryengineV1Answer", + "properties": { + "answerSkippedReasons": { + "description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", + "items": { + "enum": [ + "ANSWER_SKIPPED_REASON_UNSPECIFIED", + "ADVERSARIAL_QUERY_IGNORED", + "NON_ANSWER_SEEKING_QUERY_IGNORED", + "OUT_OF_DOMAIN_QUERY_IGNORED", + "POTENTIAL_POLICY_VIOLATION" + ], + "enumDescriptions": [ + "Default value. The answer skipped reason is not specified.", + "The adversarial query ignored case.", + "The non-answer seeking query ignored case.", + "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", + "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic." + ], + "type": "string" + }, + "type": "array" + }, + "answerText": { + "description": "The textual answer.", + "type": "string" + }, + "citations": { + "description": "Citations.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerCitation" + }, + "type": "array" + }, + "completeTime": { + "description": "Output only. Answer completed timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Answer creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", + "type": "string" + }, + "queryUnderstandingInfo": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo", + "description": "Query understanding information." + }, + "references": { + "description": "References.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerReference" + }, + "type": "array" + }, + "relatedQuestions": { + "description": "Suggested related questions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "The state of the answer generation.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Unknown.", + "Answer generation is currently in progress.", + "Answer generation currently failed.", + "Answer generation has succeeded." + ], + "type": "string" + }, + "steps": { + "description": "Answer generation steps.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerStep" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerCitation": { + "description": "Citation info for a segment.", + "id": "GoogleCloudDiscoveryengineV1AnswerCitation", + "properties": { + "endIndex": { + "description": "End of the attributed segment, exclusive.", + "format": "int64", + "type": "string" + }, + "sources": { + "description": "Citation sources for the attributed segment.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerCitationSource" + }, + "type": "array" + }, + "startIndex": { + "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerCitationSource": { + "description": "Citation source.", + "id": "GoogleCloudDiscoveryengineV1AnswerCitationSource", + "properties": { + "referenceId": { + "description": "ID of the citation source.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequest": { + "description": "Request message for ConversationalSearchService.AnswerQuery method.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequest", + "properties": { + "answerGenerationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec", + "description": "Answer generation specification." + }, + "asynchronousMode": { + "description": "Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", + "type": "boolean" + }, + "query": { + "$ref": "GoogleCloudDiscoveryengineV1Query", + "description": "Required. Current user query." + }, + "queryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec", + "description": "Query understanding specification." + }, + "relatedQuestionsSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec", + "description": "Related questions specification." + }, + "safetySpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec", + "description": "Model specification." + }, + "searchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec", + "description": "Search specification." + }, + "session": { + "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", + "type": "string" + }, + "userPseudoId": { + "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec": { + "description": "Answer generation specification.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec", + "properties": { + "answerLanguageCode": { + "description": "Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", + "type": "string" + }, + "ignoreAdversarialQuery": { + "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.", + "type": "boolean" + }, + "ignoreNonAnswerSeekingQuery": { + "description": "Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.", + "type": "boolean" + }, + "includeCitations": { + "description": "Specifies whether to include citation metadata in the answer. The default value is `false`.", + "type": "boolean" + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec", + "description": "Answer generation model specification." + }, + "promptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec", + "description": "Answer generation prompt specification." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec": { + "description": "Answer Generation Model specification.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec", + "properties": { + "modelVersion": { + "description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec": { + "description": "Answer generation prompt specification.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec", + "properties": { + "preamble": { + "description": "Customized preamble.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec": { + "description": "Query understanding specification.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec", + "properties": { + "queryClassificationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", + "description": "Query classification specification." + }, + "queryRephraserSpec": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", + "description": "Query rephraser specification." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": { + "description": "Query classification specification.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", + "properties": { + "types": { + "description": "Enabled query classification types.", + "items": { + "enum": [ + "TYPE_UNSPECIFIED", + "ADVERSARIAL_QUERY", + "NON_ANSWER_SEEKING_QUERY" + ], + "enumDescriptions": [ + "Unspecified query classification type.", + "Adversarial query classification type.", + "Non-answer-seeking query classification type." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": { + "description": "Query rephraser specification.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", + "properties": { + "disable": { + "description": "Disable query rephraser.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec": { + "description": "Related questions specification.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec", + "properties": { + "enable": { + "description": "Enable related questions feature if true.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec": { + "description": "Safety specification.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec", + "properties": { + "enable": { + "description": "Enable the safety filtering on the answer response. It is false by default.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec": { + "description": "Search specification.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec", + "properties": { + "searchParams": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams", + "description": "Search parameters." + }, + "searchResultList": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList", + "description": "Search result list." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams": { + "description": "Search parameters.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams", + "properties": { + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec", + "description": "Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)" + }, + "filter": { + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" + }, + "maxReturnResults": { + "description": "Number of search results to return. The default value is 10.", + "format": "int32", + "type": "integer" + }, + "orderBy": { + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList": { + "description": "Search result list.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList", + "properties": { + "searchResults": { + "description": "Search results.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult": { + "description": "Search result.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult", + "properties": { + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", + "description": "Chunk information." + }, + "unstructuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", + "description": "Unstructured document information." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", + "properties": { + "chunk": { + "description": "Chunk resource name.", + "type": "string" + }, + "content": { + "description": "Chunk textual content.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": { + "description": "Unstructured document information.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", + "properties": { + "document": { + "description": "Document resource name.", + "type": "string" + }, + "documentContexts": { + "description": "List of document contexts.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" + }, + "type": "array" + }, + "extractiveAnswers": { + "description": "List of extractive answers.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" + }, + "type": "array" + }, + "extractiveSegments": { + "description": "List of extractive segments.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment" + }, + "type": "array" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": { + "description": "Document context.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", + "properties": { + "content": { + "description": "Document content.", + "type": "string" + }, + "pageIdentifier": { + "description": "Page identifier.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": { + "description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer", + "properties": { + "content": { + "description": "Extractive answer content.", + "type": "string" + }, + "pageIdentifier": { + "description": "Page identifier.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { + "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", + "properties": { + "content": { + "description": "Extractive segment content.", + "type": "string" + }, + "pageIdentifier": { + "description": "Page identifier.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryResponse": { + "description": "Response message for ConversationalSearchService.AnswerQuery method.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryResponse", + "properties": { + "answer": { + "$ref": "GoogleCloudDiscoveryengineV1Answer", + "description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." + }, + "answerQueryToken": { + "description": "A global unique ID used for logging.", + "type": "string" + }, + "session": { + "$ref": "GoogleCloudDiscoveryengineV1Session", + "description": "Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo": { + "description": "Query understanding information.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo", + "properties": { + "queryClassificationInfo": { + "description": "Query classification information.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo": { + "description": "Query classification information.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo", + "properties": { + "positive": { + "description": "Classification output.", + "type": "boolean" + }, + "type": { + "description": "Query classification type.", + "enum": [ + "TYPE_UNSPECIFIED", + "ADVERSARIAL_QUERY", + "NON_ANSWER_SEEKING_QUERY" + ], + "enumDescriptions": [ + "Unspecified query classification type.", + "Adversarial query classification type.", + "Non-answer-seeking query classification type." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerReference": { + "description": "Reference.", + "id": "GoogleCloudDiscoveryengineV1AnswerReference", + "properties": { + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo", + "description": "Chunk information." + }, + "unstructuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo", + "description": "Unstructured document information." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo", + "properties": { + "chunk": { + "description": "Chunk resource name.", + "type": "string" + }, + "content": { + "description": "Chunk textual content.", + "type": "string" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata", + "description": "Document metadata." + }, + "relevanceScore": { + "description": "Relevance score.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata": { + "description": "Document metadata.", + "id": "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata", + "properties": { + "document": { + "description": "Document resource name.", + "type": "string" + }, + "pageIdentifier": { + "description": "Page identifier.", + "type": "string" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo": { + "description": "Unstructured document information.", + "id": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo", + "properties": { + "chunkContents": { + "description": "List of cited chunk contents derived from document content.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent" + }, + "type": "array" + }, + "document": { + "description": "Document resource name.", + "type": "string" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent": { + "description": "Chunk content.", + "id": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent", + "properties": { + "content": { + "description": "Chunk textual content.", + "type": "string" + }, + "pageIdentifier": { + "description": "Page identifier.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerStep": { + "description": "Step information.", + "id": "GoogleCloudDiscoveryengineV1AnswerStep", + "properties": { + "actions": { + "description": "Actions.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerStepAction" + }, + "type": "array" + }, + "description": { + "description": "The description of the step.", + "type": "string" + }, + "state": { + "description": "The state of the step.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Unknown.", + "Step is currently in progress.", + "Step currently failed.", + "Step has succeeded." + ], + "type": "string" + }, + "thought": { + "description": "The thought of the step.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingErrorLog": { - "description": "An error log which is reported to the Error Reporting system.", - "id": "GoogleCloudDiscoveryengineLoggingErrorLog", + "GoogleCloudDiscoveryengineV1AnswerStepAction": { + "description": "Action.", + "id": "GoogleCloudDiscoveryengineV1AnswerStepAction", "properties": { - "context": { - "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", - "description": "A description of the context in which the error occurred." - }, - "importPayload": { - "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", - "description": "The error payload that is populated on LRO import APIs." - }, - "message": { - "description": "A message describing the error.", - "type": "string" - }, - "requestPayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The API request payload, represented as a protocol buffer. Most API request types are supported\u2014for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", - "type": "object" - }, - "responsePayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", - "type": "object" - }, - "serviceContext": { - "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", - "description": "The service context in which this error has occurred." + "observation": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation", + "description": "Observation." }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The RPC status associated with the error log." + "searchAction": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction", + "description": "Search action." } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { - "description": "HTTP request data that is related to a reported error.", - "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "GoogleCloudDiscoveryengineV1AnswerStepActionObservation": { + "description": "Observation.", + "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation", "properties": { - "responseStatusCode": { - "description": "The HTTP response status code for the request.", - "format": "int32", - "type": "integer" + "searchResults": { + "description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingImportErrorContext": { - "description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", - "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult": { + "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult", "properties": { + "chunkInfo": { + "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo" + }, + "type": "array" + }, "document": { - "description": "The detailed content which caused the error on importing a document.", + "description": "Document resource name.", "type": "string" }, - "gcsPath": { - "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", - "type": "string" + "snippetInfo": { + "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo" + }, + "type": "array" }, - "lineNumber": { - "description": "Line number of the content in file. Should be empty for permission or batch operation error.", + "title": { + "description": "Title.", "type": "string" }, - "operation": { - "description": "The operation resource name of the LRO.", + "uri": { + "description": "URI for the document.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo", + "properties": { + "chunk": { + "description": "Chunk resource name.", "type": "string" }, - "userEvent": { - "description": "The detailed content which caused the error on importing a user event.", + "content": { + "description": "Chunk textual content.", "type": "string" + }, + "relevanceScore": { + "description": "Relevance score.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingServiceContext": { - "description": "Describes a running service that sends errors.", - "id": "GoogleCloudDiscoveryengineLoggingServiceContext", + "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo": { + "description": "Snippet information.", + "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo", "properties": { - "service": { - "description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.", + "snippet": { + "description": "Snippet content.", + "type": "string" + }, + "snippetStatus": { + "description": "Status of the snippet defined by the search team.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingSourceLocation": { - "description": "Indicates a location in the source code of the service for which errors are reported.", - "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction": { + "description": "Search action.", + "id": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction", "properties": { - "functionName": { - "description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", + "query": { + "description": "The query to search.", "type": "string" } }, @@ -5423,7 +6891,7 @@ "type": "array" }, "quantity": { - "description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`", + "description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`", "format": "int32", "type": "integer" }, @@ -5560,7 +7028,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.", + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -5776,7 +7244,7 @@ "id": "GoogleCloudDiscoveryengineV1FirestoreSource", "properties": { "collectionId": { - "description": "Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.", + "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.", "type": "string" }, "databaseId": { @@ -5799,11 +7267,11 @@ "id": "GoogleCloudDiscoveryengineV1GcsSource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.", + "description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.", "type": "string" }, "inputUris": { - "description": "Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).", + "description": "Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).", "items": { "type": "string" }, @@ -6254,6 +7722,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ListSessionsResponse": { + "description": "Response for ListSessions method.", + "id": "GoogleCloudDiscoveryengineV1ListSessionsResponse", + "properties": { + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", + "type": "string" + }, + "sessions": { + "description": "All the Sessions for a given data store.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1Session" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ListTargetSitesResponse": { "description": "Response message for SiteSearchEngineService.ListTargetSites method.", "id": "GoogleCloudDiscoveryengineV1ListTargetSitesResponse", @@ -6450,16 +7936,100 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1Query": { + "description": "Defines a user inputed query.", + "id": "GoogleCloudDiscoveryengineV1Query", + "properties": { + "queryId": { + "description": "Unique Id for the query.", + "type": "string" + }, + "text": { + "description": "Plain text.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1RankRequest": { + "description": "Request message for RankService.Rank method.", + "id": "GoogleCloudDiscoveryengineV1RankRequest", + "properties": { + "ignoreRecordDetailsInResponse": { + "description": "If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.", + "type": "boolean" + }, + "model": { + "description": "The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.", + "type": "string" + }, + "query": { + "description": "The query to use.", + "type": "string" + }, + "records": { + "description": "Required. A list of records to rank. At most 200 records to rank.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1RankingRecord" + }, + "type": "array" + }, + "topN": { + "description": "The number of results to return. If this is unset or no bigger than zero, returns all results.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1RankResponse": { + "description": "Response message for RankService.Rank method.", + "id": "GoogleCloudDiscoveryengineV1RankResponse", + "properties": { + "records": { + "description": "A list of records sorted by descending score.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1RankingRecord" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1RankingRecord": { + "description": "Record message for RankService.Rank method.", + "id": "GoogleCloudDiscoveryengineV1RankingRecord", + "properties": { + "content": { + "description": "The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.", + "type": "string" + }, + "id": { + "description": "The unique ID to represent the record.", + "type": "string" + }, + "score": { + "description": "The score of this record based on the given query and selected model.", + "format": "float", + "type": "number" + }, + "title": { + "description": "The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1RecommendRequest": { "description": "Request message for Recommend method.", "id": "GoogleCloudDiscoveryengineV1RecommendRequest", "properties": { "filter": { - "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.", + "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", "type": "string" }, "pageSize": { - "description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.", + "description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.", "format": "int32", "type": "integer" }, @@ -6467,7 +8037,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.", + "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.", "type": "object" }, "userEvent": { @@ -6482,7 +8052,7 @@ "type": "object" }, "validateOnly": { - "description": "Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.", + "description": "Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.", "type": "boolean" } }, @@ -6533,7 +8103,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.", + "description": "Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.", "type": "object" } }, @@ -6613,7 +8183,7 @@ "properties": { "boostSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec", - "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)" + "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, "branch": { "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", @@ -6628,7 +8198,7 @@ "description": "A specification for configuring the behavior of content search." }, "dataStoreSpecs": { - "description": "A list of data store specs to apply on a search call.", + "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec" }, @@ -6671,7 +8241,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: \"au\" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1", + "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, "query": { @@ -6873,7 +8443,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec": { - "description": "A struct to define data stores to filter on in a search call.", + "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec", "properties": { "dataStore": { @@ -6903,7 +8473,7 @@ "description": "Required. The facet key specification." }, "limit": { - "description": "Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", "type": "integer" } @@ -6919,7 +8489,7 @@ "type": "boolean" }, "contains": { - "description": "Only get facet values that contains the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", + "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, @@ -6998,7 +8568,7 @@ "id": "GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec", "properties": { "mode": { - "description": "The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.", + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", "enum": [ "MODE_UNSPECIFIED", "SUGGESTION_ONLY", @@ -7006,7 +8576,7 @@ ], "enumDescriptions": [ "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", - "Search API will try to find a spell suggestion if there is any and put in the SearchResponse.corrected_query. The spell suggestion will not be used as the search query.", + "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." ], "type": "string" @@ -7073,7 +8643,7 @@ "type": "boolean" }, "key": { - "description": "The key for this facet. E.g., \"colors\" or \"price\". It matches SearchRequest.FacetSpec.FacetKey.key.", + "description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.", "type": "string" }, "values": { @@ -7128,7 +8698,7 @@ "properties": { "document": { "$ref": "GoogleCloudDiscoveryengineV1Document", - "description": "The document data snippet in the search response. Only fields that are marked as retrievable are populated." + "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." }, "id": { "description": "Document.id of the searched Document.", @@ -7138,7 +8708,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1SearchResponseSummary": { - "description": "Summary of the top N search result specified by the summary spec.", + "description": "Summary of the top N search results specified by the summary spec.", "id": "GoogleCloudDiscoveryengineV1SearchResponseSummary", "properties": { "safetyAttributes": { @@ -7314,6 +8884,67 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1Session": { + "description": "External session proto definition.", + "id": "GoogleCloudDiscoveryengineV1Session", + "properties": { + "endTime": { + "description": "Output only. The time the session finished.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + "type": "string" + }, + "startTime": { + "description": "Output only. The time the session started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "The state of the session.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS" + ], + "enumDescriptions": [ + "State is unspecified.", + "The session is currently open." + ], + "type": "string" + }, + "turns": { + "description": "Turns.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1SessionTurn" + }, + "type": "array" + }, + "userPseudoId": { + "description": "A unique identifier for tracking users.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1SessionTurn": { + "description": "Represents a turn, including a query from the user and a answer from service.", + "id": "GoogleCloudDiscoveryengineV1SessionTurn", + "properties": { + "answer": { + "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", + "type": "string" + }, + "query": { + "$ref": "GoogleCloudDiscoveryengineV1Query", + "description": "The user query." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SiteSearchEngine": { "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", "id": "GoogleCloudDiscoveryengineV1SiteSearchEngine", @@ -7592,7 +9223,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1UserEvent": { - "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.", + "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.", "id": "GoogleCloudDiscoveryengineV1UserEvent", "properties": { "attributes": { @@ -7662,7 +9293,7 @@ "type": "string" }, "tagIds": { - "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.", + "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.", "items": { "type": "string" }, @@ -8627,7 +10258,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.", + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -9679,7 +11310,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { "answer": { - "description": "The resource name of the answer to the user query.", + "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, "query": { @@ -10367,7 +11998,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.", + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", diff --git a/DiscoveryJson/discoveryengine_v1alpha.json b/DiscoveryJson/discoveryengine_v1alpha.json index af3ee5655a..ab689a347d 100644 --- a/DiscoveryJson/discoveryengine_v1alpha.json +++ b/DiscoveryJson/discoveryengine_v1alpha.json @@ -689,7 +689,7 @@ ], "parameters": { "documentId": { - "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, @@ -786,7 +786,7 @@ ], "enumDescriptions": [ "Default value.", - "output format will be a JSON string representation of processed document." + "Output format is a JSON string representation of processed document." ], "location": "query", "type": "string" @@ -818,7 +818,7 @@ ] }, "import": { - "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.", + "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.import", @@ -855,7 +855,7 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" @@ -891,7 +891,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Document is not found, a new Document will be created.", + "description": "If set to `true` and the Document is not found, a new Document is be created.", "location": "query", "type": "boolean" }, @@ -903,7 +903,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.", + "description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1499,7 +1499,7 @@ "type": "string" }, "schemaId": { - "description": "Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", + "description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "location": "query", "type": "string" } @@ -1575,7 +1575,7 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1611,7 +1611,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.", + "description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" }, @@ -1843,7 +1843,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", + "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -2658,7 +2658,7 @@ ] }, "import": { - "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", + "description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.import", @@ -3386,7 +3386,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", + "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -4011,7 +4011,7 @@ ], "parameters": { "documentId": { - "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, @@ -4108,7 +4108,7 @@ ], "enumDescriptions": [ "Default value.", - "output format will be a JSON string representation of processed document." + "Output format is a JSON string representation of processed document." ], "location": "query", "type": "string" @@ -4140,7 +4140,7 @@ ] }, "import": { - "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.", + "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.dataStores.branches.documents.import", @@ -4177,7 +4177,7 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" @@ -4213,7 +4213,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Document is not found, a new Document will be created.", + "description": "If set to `true` and the Document is not found, a new Document is be created.", "location": "query", "type": "boolean" }, @@ -4225,7 +4225,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.", + "description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4792,7 +4792,7 @@ "type": "string" }, "schemaId": { - "description": "Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", + "description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "location": "query", "type": "string" } @@ -4868,7 +4868,7 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.", "format": "int32", "location": "query", "type": "integer" @@ -4904,7 +4904,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.", + "description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" }, @@ -5064,7 +5064,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", + "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -5673,7 +5673,7 @@ ] }, "import": { - "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", + "description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.dataStores.userEvents.import", @@ -6067,7 +6067,7 @@ } } }, - "revision": "20240512", + "revision": "20240517", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6613,7 +6613,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.", + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -7369,7 +7369,7 @@ "description": "Search specification." }, "session": { - "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol \u201c-\u201d as session id. A new id will be automatically generated and assigned.", + "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", "type": "string" }, "userPseudoId": { @@ -8373,7 +8373,7 @@ "description": "Page span of the chunk." }, "relevanceScore": { - "description": "Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse", + "description": "Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse", "format": "double", "type": "number" } @@ -9166,7 +9166,7 @@ "type": "array" }, "quantity": { - "description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`", + "description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`", "format": "int32", "type": "integer" }, @@ -9370,7 +9370,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.", + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -9938,7 +9938,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", "properties": { "collectionId": { - "description": "Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.", + "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.", "type": "string" }, "databaseId": { @@ -9961,11 +9961,11 @@ "id": "GoogleCloudDiscoveryengineV1alphaGcsSource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.", + "description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.", "type": "string" }, "inputUris": { - "description": "Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).", + "description": "Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).", "items": { "type": "string" }, @@ -11028,11 +11028,11 @@ "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest", "properties": { "filter": { - "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.", + "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", "type": "string" }, "pageSize": { - "description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.", + "description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.", "format": "int32", "type": "integer" }, @@ -11040,7 +11040,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.", + "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.", "type": "object" }, "userEvent": { @@ -11055,7 +11055,7 @@ "type": "object" }, "validateOnly": { - "description": "Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.", + "description": "Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.", "type": "boolean" } }, @@ -11106,7 +11106,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.", + "description": "Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.", "type": "object" } }, @@ -11374,7 +11374,7 @@ "properties": { "boostSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", - "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)" + "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, "branch": { "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", @@ -11393,7 +11393,7 @@ "description": "Custom fine tuning configs." }, "dataStoreSpecs": { - "description": "A list of data store specs to apply on a search call.", + "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, @@ -11440,7 +11440,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: \"au\" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1", + "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, "query": { @@ -11529,7 +11529,7 @@ "enumDescriptions": [ "Unspecified AttributeType.", "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", - "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. E.g. `5D`, `3DT12H30M`, `T24H`." + "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." ], "type": "string" }, @@ -11745,7 +11745,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { - "description": "A struct to define data stores to filter on in a search call.", + "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", "properties": { "dataStore": { @@ -11808,7 +11808,7 @@ "description": "Required. The facet key specification." }, "limit": { - "description": "Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", "type": "integer" } @@ -11824,7 +11824,7 @@ "type": "boolean" }, "contains": { - "description": "Only get facet values that contains the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", + "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, @@ -11903,7 +11903,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "properties": { "mode": { - "description": "The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.", + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", "enum": [ "MODE_UNSPECIFIED", "SUGGESTION_ONLY", @@ -11911,7 +11911,7 @@ ], "enumDescriptions": [ "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", - "Search API will try to find a spell suggestion if there is any and put in the SearchResponse.corrected_query. The spell suggestion will not be used as the search query.", + "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." ], "type": "string" @@ -11995,7 +11995,7 @@ "type": "boolean" }, "key": { - "description": "The key for this facet. E.g., \"colors\" or \"price\". It matches SearchRequest.FacetSpec.FacetKey.key.", + "description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.", "type": "string" }, "values": { @@ -12069,11 +12069,11 @@ "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute", "properties": { "attributeKey": { - "description": "Attribute key used to refine the results e.g. 'movie_type'.", + "description": "Attribute key used to refine the results. For example, `\"movie_type\"`.", "type": "string" }, "attributeValue": { - "description": "Attribute value used to refine the results e.g. 'drama'.", + "description": "Attribute value used to refine the results. For example, `\"drama\"`.", "type": "string" } }, @@ -12105,7 +12105,7 @@ }, "document": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", - "description": "The document data snippet in the search response. Only fields that are marked as retrievable are populated." + "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." }, "id": { "description": "Document.id of the searched Document.", @@ -12122,7 +12122,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary": { - "description": "Summary of the top N search result specified by the summary spec.", + "description": "Summary of the top N search results specified by the summary spec.", "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", "properties": { "safetyAttributes": { @@ -12519,7 +12519,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { "answer": { - "description": "The resource name of the answer to the user query.", + "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, "query": { @@ -12927,7 +12927,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaUserEvent": { - "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.", + "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.", "id": "GoogleCloudDiscoveryengineV1alphaUserEvent", "properties": { "attributes": { @@ -12997,7 +12997,7 @@ "type": "string" }, "tagIds": { - "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.", + "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.", "items": { "type": "string" }, @@ -13479,7 +13479,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.", + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", diff --git a/DiscoveryJson/discoveryengine_v1beta.json b/DiscoveryJson/discoveryengine_v1beta.json index 8f92b3d955..7524c71005 100644 --- a/DiscoveryJson/discoveryengine_v1beta.json +++ b/DiscoveryJson/discoveryengine_v1beta.json @@ -464,7 +464,7 @@ ], "parameters": { "documentId": { - "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, @@ -538,7 +538,7 @@ ] }, "import": { - "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.", + "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.import", @@ -575,7 +575,7 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" @@ -611,7 +611,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Document is not found, a new Document will be created.", + "description": "If set to `true` and the Document is not found, a new Document is be created.", "location": "query", "type": "boolean" }, @@ -623,7 +623,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.", + "description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1152,7 +1152,7 @@ "type": "string" }, "schemaId": { - "description": "Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", + "description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "location": "query", "type": "string" } @@ -1228,7 +1228,7 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1264,7 +1264,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.", + "description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" }, @@ -1496,7 +1496,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", + "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -2311,7 +2311,7 @@ ] }, "import": { - "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", + "description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.import", @@ -3011,7 +3011,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", + "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -3577,7 +3577,7 @@ ], "parameters": { "documentId": { - "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, @@ -3651,7 +3651,7 @@ ] }, "import": { - "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.", + "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.dataStores.branches.documents.import", @@ -3688,7 +3688,7 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" @@ -3724,7 +3724,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Document is not found, a new Document will be created.", + "description": "If set to `true` and the Document is not found, a new Document is be created.", "location": "query", "type": "boolean" }, @@ -3736,7 +3736,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.", + "description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4236,7 +4236,7 @@ "type": "string" }, "schemaId": { - "description": "Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", + "description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "location": "query", "type": "string" } @@ -4312,7 +4312,7 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.", "format": "int32", "location": "query", "type": "integer" @@ -4348,7 +4348,7 @@ ], "parameters": { "allowMissing": { - "description": "If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.", + "description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" }, @@ -4508,7 +4508,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", + "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -5117,7 +5117,7 @@ ] }, "import": { - "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", + "description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import", "httpMethod": "POST", "id": "discoveryengine.projects.locations.dataStores.userEvents.import", @@ -5417,7 +5417,7 @@ } } }, - "revision": "20240512", + "revision": "20240517", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5963,7 +5963,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.", + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -7469,7 +7469,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.", + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -8521,7 +8521,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { "answer": { - "description": "The resource name of the answer to the user query.", + "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, "query": { @@ -8927,7 +8927,7 @@ "description": "Search specification." }, "session": { - "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol \u201c-\u201d as session id. A new id will be automatically generated and assigned.", + "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", "type": "string" }, "userPseudoId": { @@ -10547,7 +10547,7 @@ "type": "array" }, "quantity": { - "description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`", + "description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`", "format": "int32", "type": "integer" }, @@ -10710,7 +10710,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.", + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -10926,7 +10926,7 @@ "id": "GoogleCloudDiscoveryengineV1betaFirestoreSource", "properties": { "collectionId": { - "description": "Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.", + "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.", "type": "string" }, "databaseId": { @@ -10949,11 +10949,11 @@ "id": "GoogleCloudDiscoveryengineV1betaGcsSource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.", + "description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.", "type": "string" }, "inputUris": { - "description": "Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).", + "description": "Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).", "items": { "type": "string" }, @@ -11745,11 +11745,11 @@ "id": "GoogleCloudDiscoveryengineV1betaRecommendRequest", "properties": { "filter": { - "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.", + "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", "type": "string" }, "pageSize": { - "description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.", + "description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.", "format": "int32", "type": "integer" }, @@ -11757,7 +11757,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.", + "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.", "type": "object" }, "userEvent": { @@ -11772,7 +11772,7 @@ "type": "object" }, "validateOnly": { - "description": "Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.", + "description": "Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.", "type": "boolean" } }, @@ -11823,7 +11823,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.", + "description": "Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.", "type": "object" } }, @@ -11948,7 +11948,7 @@ "properties": { "boostSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", - "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)" + "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, "branch": { "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", @@ -11963,7 +11963,7 @@ "description": "A specification for configuring the behavior of content search." }, "dataStoreSpecs": { - "description": "A list of data store specs to apply on a search call.", + "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, @@ -12010,7 +12010,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: \"au\" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1", + "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, "query": { @@ -12099,7 +12099,7 @@ "enumDescriptions": [ "Unspecified AttributeType.", "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", - "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. E.g. `5D`, `3DT12H30M`, `T24H`." + "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." ], "type": "string" }, @@ -12280,7 +12280,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { - "description": "A struct to define data stores to filter on in a search call.", + "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", "properties": { "dataStore": { @@ -12343,7 +12343,7 @@ "description": "Required. The facet key specification." }, "limit": { - "description": "Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", "type": "integer" } @@ -12359,7 +12359,7 @@ "type": "boolean" }, "contains": { - "description": "Only get facet values that contains the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", + "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, @@ -12438,7 +12438,7 @@ "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", "properties": { "mode": { - "description": "The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.", + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", "enum": [ "MODE_UNSPECIFIED", "SUGGESTION_ONLY", @@ -12446,7 +12446,7 @@ ], "enumDescriptions": [ "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", - "Search API will try to find a spell suggestion if there is any and put in the SearchResponse.corrected_query. The spell suggestion will not be used as the search query.", + "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." ], "type": "string" @@ -12530,7 +12530,7 @@ "type": "boolean" }, "key": { - "description": "The key for this facet. E.g., \"colors\" or \"price\". It matches SearchRequest.FacetSpec.FacetKey.key.", + "description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.", "type": "string" }, "values": { @@ -12604,11 +12604,11 @@ "id": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute", "properties": { "attributeKey": { - "description": "Attribute key used to refine the results e.g. 'movie_type'.", + "description": "Attribute key used to refine the results. For example, `\"movie_type\"`.", "type": "string" }, "attributeValue": { - "description": "Attribute value used to refine the results e.g. 'drama'.", + "description": "Attribute value used to refine the results. For example, `\"drama\"`.", "type": "string" } }, @@ -12636,7 +12636,7 @@ "properties": { "document": { "$ref": "GoogleCloudDiscoveryengineV1betaDocument", - "description": "The document data snippet in the search response. Only fields that are marked as retrievable are populated." + "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." }, "id": { "description": "Document.id of the searched Document.", @@ -12653,7 +12653,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchResponseSummary": { - "description": "Summary of the top N search result specified by the summary spec.", + "description": "Summary of the top N search results specified by the summary spec.", "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary", "properties": { "safetyAttributes": { @@ -13042,7 +13042,7 @@ "id": "GoogleCloudDiscoveryengineV1betaSessionTurn", "properties": { "answer": { - "description": "The resource name of the answer to the user query.", + "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, "query": { @@ -13450,7 +13450,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1betaUserEvent": { - "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.", + "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.", "id": "GoogleCloudDiscoveryengineV1betaUserEvent", "properties": { "attributes": { @@ -13520,7 +13520,7 @@ "type": "string" }, "tagIds": { - "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.", + "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.", "items": { "type": "string" }, diff --git a/DiscoveryJson/fcmdata_v1beta1.json b/DiscoveryJson/fcmdata_v1beta1.json index 7551b69171..d5666c028a 100644 --- a/DiscoveryJson/fcmdata_v1beta1.json +++ b/DiscoveryJson/fcmdata_v1beta1.json @@ -154,7 +154,7 @@ } } }, - "revision": "20220405", + "revision": "20240521", "rootUrl": "https://fcmdata.googleapis.com/", "schemas": { "GoogleFirebaseFcmDataV1beta1AndroidDeliveryData": { @@ -185,7 +185,12 @@ "id": "GoogleFirebaseFcmDataV1beta1Data", "properties": { "countMessagesAccepted": { - "description": "Count of messages accepted by FCM intended to Android devices. The targeted device must have opted in to the collection of usage and diagnostic information.", + "description": "Count of messages accepted by FCM intended for Android devices. The targeted device must have opted in to the collection of usage and diagnostic information.", + "format": "int64", + "type": "string" + }, + "countNotificationsAccepted": { + "description": "Count of notifications accepted by FCM intended for Android devices. The targeted device must have opted in to the collection of usage and diagnostic information.", "format": "int64", "type": "string" }, @@ -200,6 +205,10 @@ "messageOutcomePercents": { "$ref": "GoogleFirebaseFcmDataV1beta1MessageOutcomePercents", "description": "Mutually exclusive breakdown of message delivery outcomes." + }, + "proxyNotificationInsightPercents": { + "$ref": "GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents", + "description": "Additional insights about proxy notification delivery." } }, "type": "object" @@ -298,6 +307,43 @@ }, "type": "object" }, + "GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents": { + "description": "Additional information about proxy notification delivery. All percentages are calculated with countNotificationsAccepted as the denominator.", + "id": "GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents", + "properties": { + "failed": { + "description": "The percentage of accepted notifications that failed to be proxied. This is usually caused by exceptions that occurred while calling [notifyAsPackage](https://developer.android.com/reference/android/app/NotificationManager#notifyAsPackage%28java.lang.String,%20java.lang.String,%20int,%20android.app.Notification%29).", + "format": "float", + "type": "number" + }, + "proxied": { + "description": "The percentage of accepted notifications that were successfully proxied by [Google Play services](https://developers.google.com/android/guides/overview).", + "format": "float", + "type": "number" + }, + "skippedNotThrottled": { + "description": "The percentage of accepted notifications that were skipped because the messages were not throttled.", + "format": "float", + "type": "number" + }, + "skippedOptedOut": { + "description": "The percentage of accepted notifications that were skipped because the app disallowed these messages to be proxied.", + "format": "float", + "type": "number" + }, + "skippedUnconfigured": { + "description": "The percentage of accepted notifications that were skipped because configurations required for notifications to be proxied were missing.", + "format": "float", + "type": "number" + }, + "skippedUnsupported": { + "description": "The percentage of accepted notifications that were skipped because proxy notification is unsupported for the recipient.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleTypeDate": { "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "GoogleTypeDate", diff --git a/DiscoveryJson/file_v1.json b/DiscoveryJson/file_v1.json index 9ec5c4f223..94ab440760 100644 --- a/DiscoveryJson/file_v1.json +++ b/DiscoveryJson/file_v1.json @@ -874,7 +874,7 @@ } } }, - "revision": "20240511", + "revision": "20240307", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1413,10 +1413,6 @@ }, "type": "array" }, - "replication": { - "$ref": "Replication", - "description": "Optional. Replicaition configuration." - }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -1894,86 +1890,6 @@ }, "type": "object" }, - "ReplicaConfig": { - "description": "Replica configuration for the instance.", - "id": "ReplicaConfig", - "properties": { - "lastActiveSyncTime": { - "description": "Output only. The timestamp of the latest replication snapshot taken on the active instance and is already replicated safely.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "peerInstance": { - "description": "Optional. The peer instance.", - "type": "string" - }, - "state": { - "description": "Output only. The replica state.", - "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "READY", - "REMOVING", - "FAILED" - ], - "enumDescriptions": [ - "State not set.", - "The replica is being created.", - "The replica is ready.", - "The replica is being removed.", - "The replica is experiencing an issue and might be unusable. You can get further details from the `stateReasons` field of the `ReplicaConfig` object." - ], - "readOnly": true, - "type": "string" - }, - "stateReasons": { - "description": "Output only. Additional information about the replication state, if available.", - "items": { - "enum": [ - "STATE_REASON_UNSPECIFIED", - "PEER_INSTANCE_UNREACHABLE" - ], - "enumDescriptions": [ - "Reason not specified.", - "The peer instance is unreachable." - ], - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "Replication": { - "description": "Replication specifications.", - "id": "Replication", - "properties": { - "replicas": { - "description": "Optional. Replicas configuration on the instance. For now, only a single replica config is supported.", - "items": { - "$ref": "ReplicaConfig" - }, - "type": "array" - }, - "role": { - "description": "Optional. The replication role.", - "enum": [ - "ROLE_UNSPECIFIED", - "ACTIVE", - "STANDBY" - ], - "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." - ], - "type": "string" - } - }, - "type": "object" - }, "RestoreInstanceRequest": { "description": "RestoreInstanceRequest restores an existing instance's file share from a backup.", "id": "RestoreInstanceRequest", diff --git a/DiscoveryJson/firebaseml_v2beta.json b/DiscoveryJson/firebaseml_v2beta.json index 6adf8164e9..0347ff9cd6 100644 --- a/DiscoveryJson/firebaseml_v2beta.json +++ b/DiscoveryJson/firebaseml_v2beta.json @@ -206,7 +206,7 @@ } } }, - "revision": "20240516", + "revision": "20240521", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Blob": { @@ -627,6 +627,10 @@ "description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", "type": "string" }, + "responseSchema": { + "$ref": "Schema", + "description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response." + }, "stopSequences": { "description": "Optional. Stop sequences.", "items": { diff --git a/DiscoveryJson/firestore_v1.json b/DiscoveryJson/firestore_v1.json index c340971510..b9af26f99c 100644 --- a/DiscoveryJson/firestore_v1.json +++ b/DiscoveryJson/firestore_v1.json @@ -1677,7 +1677,7 @@ } } }, - "revision": "20240512", + "revision": "20240521", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2582,7 +2582,7 @@ "type": "string" }, "deleteTime": { - "description": "Output only. The timestamp at which this database was soft deleted. Only set if the database has been soft deleted.", + "description": "Output only. The timestamp at which this database was deleted. Only set if the database has been deleted.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -2762,7 +2762,7 @@ "id": "GoogleFirestoreAdminV1ExportDocumentsRequest", "properties": { "collectionIds": { - "description": "Which collection ids to export. Unspecified means all collections.", + "description": "Which collection ids to export. Unspecified means all collections. Each collection id in this list must be unique.", "items": { "type": "string" }, @@ -2959,7 +2959,7 @@ "id": "GoogleFirestoreAdminV1ImportDocumentsRequest", "properties": { "collectionIds": { - "description": "Which collection ids to import. Unspecified means all collections included in the import.", + "description": "Which collection ids to import. Unspecified means all collections included in the import. Each collection id in this list must be unique.", "items": { "type": "string" }, diff --git a/DiscoveryJson/gmail_v1.json b/DiscoveryJson/gmail_v1.json index 9789aa98c2..41adb4f0f3 100644 --- a/DiscoveryJson/gmail_v1.json +++ b/DiscoveryJson/gmail_v1.json @@ -154,11 +154,6 @@ "userId" ], "parameters": { - "temporaryEeccBypass": { - "default": "false", - "location": "query", - "type": "boolean" - }, "userId": { "default": "me", "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", @@ -927,11 +922,6 @@ "repeated": true, "type": "string" }, - "temporaryEeccBypass": { - "default": "false", - "location": "query", - "type": "boolean" - }, "userId": { "default": "me", "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", @@ -1138,11 +1128,6 @@ "location": "query", "type": "string" }, - "temporaryEeccBypass": { - "default": "false", - "location": "query", - "type": "boolean" - }, "userId": { "default": "me", "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", @@ -1340,11 +1325,6 @@ "required": true, "type": "string" }, - "temporaryEeccBypass": { - "default": "false", - "location": "query", - "type": "boolean" - }, "userId": { "default": "me", "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", @@ -2911,11 +2891,6 @@ "repeated": true, "type": "string" }, - "temporaryEeccBypass": { - "default": "false", - "location": "query", - "type": "boolean" - }, "userId": { "default": "me", "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", @@ -2976,11 +2951,6 @@ "location": "query", "type": "string" }, - "temporaryEeccBypass": { - "default": "false", - "location": "query", - "type": "boolean" - }, "userId": { "default": "me", "description": "The user's email address. The special value `me` can be used to indicate the authenticated user.", @@ -3107,7 +3077,7 @@ } } }, - "revision": "20240422", + "revision": "20240520", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { diff --git a/DiscoveryJson/iam_v1.json b/DiscoveryJson/iam_v1.json index 9589df3fa1..c68ed9ad7f 100644 --- a/DiscoveryJson/iam_v1.json +++ b/DiscoveryJson/iam_v1.json @@ -969,7 +969,7 @@ ], "parameters": { "parent": { - "description": "The `parent` parameter's value depends on the target resource for the request, namely [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`projects.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `parent` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [projects.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1003,7 +1003,7 @@ "type": "string" }, "name": { - "description": "The `name` parameter's value depends on the target resource for the request, namely [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^organizations/[^/]+/roles/[^/]+$", "required": true, @@ -1028,7 +1028,7 @@ ], "parameters": { "name": { - "description": "The `name` parameter's value depends on the target resource for the request, namely [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [`projects.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `name` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^organizations/[^/]+/roles/[^/]+$", "required": true, @@ -1064,7 +1064,7 @@ "type": "string" }, "parent": { - "description": "The `parent` parameter's value depends on the target resource for the request, namely [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `parent` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [projects.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1107,7 +1107,7 @@ ], "parameters": { "name": { - "description": "The `name` parameter's value depends on the target resource for the request, namely [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^organizations/[^/]+/roles/[^/]+$", "required": true, @@ -1141,7 +1141,7 @@ ], "parameters": { "name": { - "description": "The `name` parameter's value depends on the target resource for the request, namely [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^organizations/[^/]+/roles/[^/]+$", "required": true, @@ -1192,7 +1192,7 @@ "oauthClients": { "methods": { "create": { - "description": "Creates a new OauthClient. You cannot reuse the name of a deleted oauth client until 30 days after deletion.", + "description": "Creates a new OauthClient. You cannot reuse the name of a deleted OauthClient until 30 days after deletion.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/oauthClients", "httpMethod": "POST", "id": "iam.projects.locations.oauthClients.create", @@ -1201,12 +1201,12 @@ ], "parameters": { "oauthClientId": { - "description": "Required. The ID to use for the oauth client, which becomes the final component of the resource name. This value should be a string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix `gcp-` is reserved for use by Google, and may not be specified.", + "description": "Required. The ID to use for the OauthClient, which becomes the final component of the resource name. This value should be a string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix `gcp-` is reserved for use by Google, and may not be specified.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource to create the oauth client in. The only supported location is `global`.", + "description": "Required. The parent resource to create the OauthClient in. The only supported location is `global`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1225,7 +1225,7 @@ ] }, "delete": { - "description": "Deletes a OauthClient. You cannot use a deleted oauth client. However, deletion does not revoke access tokens that have already been issued; they continue to grant access. Deletion does revoke refresh tokens that have already been issued; They cannot be used to renew an access token. If the oauth client is undeleted, and the refresh tokens are not expired, they are valid for token exchange again. You can undelete an oauth client for 30 days. After 30 days, deletion is permanent. You cannot update deleted oauth clients. However, you can view and list them.", + "description": "Deletes an OauthClient. You cannot use a deleted OauthClient. However, deletion does not revoke access tokens that have already been issued. They continue to grant access. Deletion does revoke refresh tokens that have already been issued. They cannot be used to renew an access token. If the OauthClient is undeleted, and the refresh tokens are not expired, they are valid for token exchange again. You can undelete an OauthClient for 30 days. After 30 days, deletion is permanent. You cannot update deleted OauthClients. However, you can view and list them.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}", "httpMethod": "DELETE", "id": "iam.projects.locations.oauthClients.delete", @@ -1234,7 +1234,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the oauth client to delete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`.", + "description": "Required. The name of the OauthClient to delete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$", "required": true, @@ -1259,7 +1259,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the oauth client to retrieve. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`.", + "description": "Required. The name of the OauthClient to retrieve. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$", "required": true, @@ -1275,7 +1275,7 @@ ] }, "list": { - "description": "Lists all non-deleted OauthClientss in a project. If `show_deleted` is set to `true`, then deleted oauth clients are also listed.", + "description": "Lists all non-deleted OauthClients in a project. If `show_deleted` is set to `true`, then deleted OauthClients are also listed.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/oauthClients", "httpMethod": "GET", "id": "iam.projects.locations.oauthClients.list", @@ -1284,7 +1284,7 @@ ], "parameters": { "pageSize": { - "description": "Optional. The maximum number of oauth clients to return. If unspecified, at most 50 oauth clients will be returned. The maximum value is 100; values above 100 are truncated to 100.", + "description": "Optional. The maximum number of OauthClients to return. If unspecified, at most 50 OauthClients will be returned. The maximum value is 100; values above 100 are truncated to 100.", "format": "int32", "location": "query", "type": "integer" @@ -1295,14 +1295,14 @@ "type": "string" }, "parent": { - "description": "Required. The parent to list oauth clients for.", + "description": "Required. The parent to list OauthClients for.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "showDeleted": { - "description": "Optional. Whether to return soft-deleted oauth clients.", + "description": "Optional. Whether to return soft-deleted OauthClients.", "location": "query", "type": "boolean" } @@ -1325,7 +1325,7 @@ ], "parameters": { "name": { - "description": "Immutable. The resource name of the oauth client. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.", + "description": "Immutable. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$", "required": true, @@ -1350,7 +1350,7 @@ ] }, "undelete": { - "description": "Undeletes a OauthClient, as long as it was deleted fewer than 30 days ago.", + "description": "Undeletes an OauthClient, as long as it was deleted fewer than 30 days ago.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}:undelete", "httpMethod": "POST", "id": "iam.projects.locations.oauthClients.undelete", @@ -1359,7 +1359,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the oauth client to undelete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`.", + "description": "Required. The name of the OauthClient to undelete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$", "required": true, @@ -1391,12 +1391,12 @@ ], "parameters": { "oauthClientCredentialId": { - "description": "Required. The ID to use for the oauth client credential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix `gcp-` is reserved for use by Google, and may not be specified.", + "description": "Required. The ID to use for the OauthClientCredential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix `gcp-` is reserved for use by Google, and may not be specified.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource to create the oauth client Credential in.", + "description": "Required. The parent resource to create the OauthClientCredential in.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$", "required": true, @@ -1415,7 +1415,7 @@ ] }, "delete": { - "description": "Deletes a OauthClientCredential. Before deleting an oauth client credential, it should first be disabled.", + "description": "Deletes an OauthClientCredential. Before deleting an OauthClientCredential, it should first be disabled.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}/credentials/{credentialsId}", "httpMethod": "DELETE", "id": "iam.projects.locations.oauthClients.credentials.delete", @@ -1424,7 +1424,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the oauth client credential to delete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`.", + "description": "Required. The name of the OauthClientCredential to delete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+/credentials/[^/]+$", "required": true, @@ -1449,7 +1449,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the oauth client credential to retrieve. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`.", + "description": "Required. The name of the OauthClientCredential to retrieve. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+/credentials/[^/]+$", "required": true, @@ -1465,7 +1465,7 @@ ] }, "list": { - "description": "Lists all OauthClientCredentialss in a OauthClient.", + "description": "Lists all OauthClientCredentials in an OauthClient.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}/credentials", "httpMethod": "GET", "id": "iam.projects.locations.oauthClients.credentials.list", @@ -1474,7 +1474,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent to list oauth client credentials for.", + "description": "Required. The parent to list OauthClientCredentials for.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$", "required": true, @@ -1499,7 +1499,7 @@ ], "parameters": { "name": { - "description": "Immutable. The resource name of the oauth client credential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`", + "description": "Immutable. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+/credentials/[^/]+$", "required": true, @@ -2269,7 +2269,7 @@ ], "parameters": { "parent": { - "description": "The `parent` parameter's value depends on the target resource for the request, namely [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`projects.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `parent` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [projects.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2303,7 +2303,7 @@ "type": "string" }, "name": { - "description": "The `name` parameter's value depends on the target resource for the request, namely [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^projects/[^/]+/roles/[^/]+$", "required": true, @@ -2328,7 +2328,7 @@ ], "parameters": { "name": { - "description": "The `name` parameter's value depends on the target resource for the request, namely [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [`projects.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `name` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^projects/[^/]+/roles/[^/]+$", "required": true, @@ -2364,7 +2364,7 @@ "type": "string" }, "parent": { - "description": "The `parent` parameter's value depends on the target resource for the request, namely [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `parent` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [projects.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2407,7 +2407,7 @@ ], "parameters": { "name": { - "description": "The `name` parameter's value depends on the target resource for the request, namely [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^projects/[^/]+/roles/[^/]+$", "required": true, @@ -2441,7 +2441,7 @@ ], "parameters": { "name": { - "description": "The `name` parameter's value depends on the target resource for the request, namely [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^projects/[^/]+/roles/[^/]+$", "required": true, @@ -2598,7 +2598,7 @@ ] }, "getIamPolicy": { - "description": "Gets the IAM policy that is attached to a ServiceAccount. This IAM policy specifies which principals have access to the service account. This method does not tell you whether the service account has been granted any roles on other resources. To check whether a service account has role grants on a resource, use the `getIamPolicy` method for that resource. For example, to view the role grants for a project, call the Resource Manager API's [`projects.getIamPolicy`](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy) method.", + "description": "Gets the IAM policy that is attached to a ServiceAccount. This IAM policy specifies which principals have access to the service account. This method does not tell you whether the service account has been granted any roles on other resources. To check whether a service account has role grants on a resource, use the `getIamPolicy` method for that resource. For example, to view the role grants for a project, call the Resource Manager API's [projects.getIamPolicy](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy) method.", "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy", "httpMethod": "POST", "id": "iam.projects.serviceAccounts.getIamPolicy", @@ -2722,7 +2722,7 @@ }, "signBlob": { "deprecated": true, - "description": "**Note:** This method is deprecated. Use the [`signBlob`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a blob using the system-managed private key for a ServiceAccount.", + "description": "**Note:** This method is deprecated. Use the [signBlob](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a blob using the system-managed private key for a ServiceAccount.", "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob", "httpMethod": "POST", "id": "iam.projects.serviceAccounts.signBlob", @@ -2751,7 +2751,7 @@ }, "signJwt": { "deprecated": true, - "description": "**Note:** This method is deprecated. Use the [`signJwt`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount.", + "description": "**Note:** This method is deprecated. Use the [signJwt](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount.", "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt", "httpMethod": "POST", "id": "iam.projects.serviceAccounts.signJwt", @@ -3130,7 +3130,7 @@ ], "parameters": { "name": { - "description": "The `name` parameter's value depends on the target resource for the request, namely [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [`projects.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `name` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "path", "pattern": "^roles/[^/]+$", "required": true, @@ -3164,7 +3164,7 @@ "type": "string" }, "parent": { - "description": "The `parent` parameter's value depends on the target resource for the request, namely [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", + "description": "The `parent` parameter's value depends on the target resource for the request, namely [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [projects.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizations.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.", "location": "query", "type": "string" }, @@ -3216,7 +3216,7 @@ } } }, - "revision": "20240502", + "revision": "20240521", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -3867,7 +3867,7 @@ "id": "ListOauthClientCredentialsResponse", "properties": { "oauthClientCredentials": { - "description": "A list of oauth client credentials.", + "description": "A list of OauthClientCredentials.", "items": { "$ref": "OauthClientCredential" }, @@ -3885,7 +3885,7 @@ "type": "string" }, "oauthClients": { - "description": "A list of oauth clients.", + "description": "A list of OauthClients.", "items": { "$ref": "OauthClient" }, @@ -4053,11 +4053,11 @@ "type": "object" }, "OauthClient": { - "description": "Represents an oauth client. Used to access Google Cloud resources on behave of a user by using OAuth2 Protocol to obtain an access token from Google Cloud Platform.", + "description": "Represents an OauthClient. Used to access Google Cloud resources on behave of a user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud Platform.", "id": "OauthClient", "properties": { "allowedGrantTypes": { - "description": "Required. The list of OAuth grant type is allowed for the oauth client.", + "description": "Required. The list of OAuth grant types is allowed for the OauthClient.", "items": { "enum": [ "GRANT_TYPE_UNSPECIFIED", @@ -4065,9 +4065,9 @@ "REFRESH_TOKEN_GRANT" ], "enumDescriptions": [ - "should not be used", - "authorization code grant", - "refresh token grant" + "Should not be used.", + "Authorization code grant.", + "Refresh token grant." ], "type": "string" }, @@ -4081,55 +4081,55 @@ "type": "array" }, "allowedScopes": { - "description": "Required. The list of scopes that the oauth client is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. * `openid`: Associate you with your personal info on Google Cloud. * `email`: See your Google Cloud Account email address.", + "description": "Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. * `openid`: Associate you with your personal info on Google Cloud. * `email`: See your Google Cloud Account email address.", "items": { "type": "string" }, "type": "array" }, "clientId": { - "description": "Output only. The system-generated oauth client id.", + "description": "Output only. The system-generated OauthClient id.", "readOnly": true, "type": "string" }, "clientType": { - "description": "Immutable. The type of oauth client. either public or private.", + "description": "Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.", "enum": [ "CLIENT_TYPE_UNSPECIFIED", "PUBLIC_CLIENT", "CONFIDENTIAL_CLIENT" ], "enumDescriptions": [ - "should not be used", - "public client has no secret", - "private client" + "Should not be used.", + "Public client has no secret.", + "Private client." ], "type": "string" }, "description": { - "description": "Optional. A user-specified description of the oauth client. Cannot exceed 256 characters.", + "description": "Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.", "type": "string" }, "disabled": { - "description": "Optional. Whether the oauth client is disabled. You cannot use a disabled oauth client for login.", + "description": "Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.", "type": "boolean" }, "displayName": { - "description": "Optional. A user-specified display name of the oauth client. Cannot exceed 32 characters.", + "description": "Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.", "type": "string" }, "expireTime": { - "description": "Output only. Time after which the oauth client will be permanently purged and cannot be recovered.", + "description": "Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { - "description": "Immutable. The resource name of the oauth client. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.", + "description": "Immutable. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.", "type": "string" }, "state": { - "description": "Output only. The state of the oauth client.", + "description": "Output only. The state of the OauthClient.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -4137,8 +4137,8 @@ ], "enumDescriptions": [ "Default value. This value is unused.", - "The oauth client is active.", - "The oauth client is soft-deleted. Soft-deleted oauth client is permanently deleted after approximately 30 days unless restored via UndeleteOauthClient." + "The OauthClient is active.", + "The OauthClient is soft-deleted. Soft-deleted OauthClient is permanently deleted after approximately 30 days unless restored via `UndeleteOauthClient`." ], "readOnly": true, "type": "string" @@ -4147,24 +4147,24 @@ "type": "object" }, "OauthClientCredential": { - "description": "Represents an oauth client credential. Used to authenticate an oauth client while accessing Google Cloud resources on behalf of a user by using OAuth2 Protocol.", + "description": "Represents an OauthClientCredential. Used to authenticate an OauthClient while accessing Google Cloud resources on behalf of a user by using OAuth 2.0 Protocol.", "id": "OauthClientCredential", "properties": { "clientSecret": { - "description": "Output only. The system-generated oauth client secret.", + "description": "Output only. The system-generated OAuth client secret. The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see [OAuth client and credential security risks and mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security)", "readOnly": true, "type": "string" }, "disabled": { - "description": "Optional. Whether the oauth client credential is disabled. You cannot use a disabled oauth client credential for OAuth.", + "description": "Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.", "type": "boolean" }, "displayName": { - "description": "Optional. A user-specified display name of the oauth client credential Cannot exceed 32 characters.", + "description": "Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters.", "type": "string" }, "name": { - "description": "Immutable. The resource name of the oauth client credential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`", + "description": "Immutable. The resource name of the OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`", "type": "string" } }, diff --git a/DiscoveryJson/migrationcenter_v1.json b/DiscoveryJson/migrationcenter_v1.json index 8296741192..9df4062c2c 100644 --- a/DiscoveryJson/migrationcenter_v1.json +++ b/DiscoveryJson/migrationcenter_v1.json @@ -2309,7 +2309,7 @@ } } }, - "revision": "20240502", + "revision": "20240516", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2666,7 +2666,7 @@ "id": "AssetPerformanceData", "properties": { "dailyResourceUsageAggregations": { - "description": "Daily resource usage aggregations. Contains all of the data available for an asset, up to the last 40 days. Aggregations are sorted from oldest to most recent.", + "description": "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.", "items": { "$ref": "DailyResourceUsageAggregation" }, diff --git a/DiscoveryJson/migrationcenter_v1alpha1.json b/DiscoveryJson/migrationcenter_v1alpha1.json index 16f54f579f..41be02e9ef 100644 --- a/DiscoveryJson/migrationcenter_v1alpha1.json +++ b/DiscoveryJson/migrationcenter_v1alpha1.json @@ -2317,7 +2317,7 @@ } } }, - "revision": "20240509", + "revision": "20240516", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2715,7 +2715,7 @@ "id": "AssetPerformanceData", "properties": { "dailyResourceUsageAggregations": { - "description": "Daily resource usage aggregations. Contains all of the data available for an asset, up to the last 40 days. Aggregations are sorted from oldest to most recent.", + "description": "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.", "items": { "$ref": "DailyResourceUsageAggregation" }, diff --git a/DiscoveryJson/networkmanagement_v1.json b/DiscoveryJson/networkmanagement_v1.json index bcd895f9f3..206fde306b 100644 --- a/DiscoveryJson/networkmanagement_v1.json +++ b/DiscoveryJson/networkmanagement_v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240424", + "revision": "20240515", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1015,10 +1015,18 @@ "description": "IP address of the target (if applicable).", "type": "string" }, + "pscGoogleApiTarget": { + "description": "PSC Google API target the packet is delivered to (if applicable).", + "type": "string" + }, "resourceUri": { "description": "URI of the resource that the packet is delivered to.", "type": "string" }, + "storageBucket": { + "description": "Name of the Cloud Storage Bucket the packet is delivered to (if applicable).", + "type": "string" + }, "target": { "description": "Target type where the packet is delivered to.", "enum": [ @@ -1036,7 +1044,8 @@ "PRIVATE_NETWORK", "CLOUD_FUNCTION", "APP_ENGINE_VERSION", - "CLOUD_RUN_REVISION" + "CLOUD_RUN_REVISION", + "GOOGLE_MANAGED_SERVICE" ], "enumDescriptions": [ "Target not specified.", @@ -1046,14 +1055,15 @@ "Target is a Google Kubernetes Engine cluster master.", "Target is a Cloud SQL instance.", "Target is a published service that uses [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).", - "Target is all Google APIs that use [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-apis).", + "Target is Google APIs that use [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-apis).", "Target is a VPC-SC that uses [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-apis).", "Target is a serverless network endpoint group.", "Target is a Cloud Storage bucket.", "Target is a private network. Used only for return traces.", "Target is a Cloud Function. Used only for return traces.", "Target is a App Engine service version. Used only for return traces.", - "Target is a Cloud Run revision. Used only for return traces." + "Target is a Cloud Run revision. Used only for return traces.", + "Target is a Google-managed service. Used only for return traces." ], "type": "string" } @@ -1128,7 +1138,8 @@ "DROPPED_INSIDE_PSC_SERVICE_PRODUCER", "LOAD_BALANCER_HAS_NO_PROXY_SUBNET", "CLOUD_NAT_NO_ADDRESSES", - "ROUTING_LOOP" + "ROUTING_LOOP", + "DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1192,7 +1203,8 @@ "Packet was dropped inside Private Service Connect service producer.", "Packet sent to a load balancer, which requires a proxy-only subnet and the subnet is not found.", "Packet sent to Cloud Nat without active NAT IPs.", - "Packet is stuck in a routing loop." + "Packet is stuck in a routing loop.", + "Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces." ], "type": "string" }, @@ -1553,19 +1565,35 @@ "id": "ForwardingRuleInfo", "properties": { "displayName": { - "description": "Name of a Compute Engine forwarding rule.", + "description": "Name of the forwarding rule.", + "type": "string" + }, + "loadBalancerName": { + "description": "Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules).", "type": "string" }, "matchedPortRange": { - "description": "Port range defined in the forwarding rule that matches the test.", + "description": "Port range defined in the forwarding rule that matches the packet.", "type": "string" }, "matchedProtocol": { - "description": "Protocol defined in the forwarding rule that matches the test.", + "description": "Protocol defined in the forwarding rule that matches the packet.", "type": "string" }, "networkUri": { - "description": "Network URI. Only valid for Internal Load Balancer.", + "description": "Network URI.", + "type": "string" + }, + "pscGoogleApiTarget": { + "description": "PSC Google API target this forwarding rule targets (if applicable).", + "type": "string" + }, + "pscServiceAttachmentUri": { + "description": "URI of the PSC service attachment this forwarding rule targets (if applicable).", + "type": "string" + }, + "region": { + "description": "Region of the forwarding rule. Set only for regional forwarding rules.", "type": "string" }, "target": { @@ -1573,7 +1601,7 @@ "type": "string" }, "uri": { - "description": "URI of a Compute Engine forwarding rule.", + "description": "URI of the forwarding rule.", "type": "string" }, "vip": { @@ -2487,6 +2515,17 @@ }, "type": "object" }, + "ServerlessNegInfo": { + "description": "For display only. Metadata associated with the serverless network endpoint group backend.", + "id": "ServerlessNegInfo", + "properties": { + "negUri": { + "description": "URI of the serverless network endpoint group.", + "type": "string" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -2627,6 +2666,10 @@ "$ref": "RouteInfo", "description": "Display information of a Compute Engine route." }, + "serverlessNeg": { + "$ref": "ServerlessNegInfo", + "description": "Display information of a Serverless network endpoint group backend. Used only for return traces." + }, "state": { "description": "Each step is in one of the pre-defined states.", "enum": [ @@ -2642,6 +2685,7 @@ "START_FROM_CLOUD_RUN_REVISION", "START_FROM_STORAGE_BUCKET", "START_FROM_PSC_PUBLISHED_SERVICE", + "START_FROM_SERVERLESS_NEG", "APPLY_INGRESS_FIREWALL_RULE", "APPLY_EGRESS_FIREWALL_RULE", "APPLY_ROUTE", @@ -2682,6 +2726,7 @@ false, false, false, + false, true, true, false, @@ -2708,6 +2753,7 @@ "Initial state: packet originating from a Cloud Run revision. A CloudRunRevisionInfo is populated with starting revision information.", "Initial state: packet originating from a Storage Bucket. Used only for return traces. The storage_bucket information is populated.", "Initial state: packet originating from a published service that uses Private Service Connect. Used only for return traces.", + "Initial state: packet originating from a serverless network endpoint group backend. Used only for return traces. The serverless_neg information is populated.", "Config checking state: verify ingress firewall rule.", "Config checking state: verify egress firewall rule.", "Config checking state: verify route.", diff --git a/DiscoveryJson/places_v1.json b/DiscoveryJson/places_v1.json index 15d50a9745..96e55d01cf 100644 --- a/DiscoveryJson/places_v1.json +++ b/DiscoveryJson/places_v1.json @@ -276,7 +276,7 @@ } } }, - "revision": "20240512", + "revision": "20240521", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -322,7 +322,7 @@ "type": "boolean" }, "includedPrimaryTypes": { - "description": "Optional. Included primary Place type (for example, \"restaurant\" or \"gas_station\") from https://developers.google.com/maps/documentation/places/web-service/place-types. A Place is only returned if its primary type is included in this list. Up to 5 values can be specified. If no types are specified, all Place types are returned.", + "description": "Optional. Included primary Place type (for example, \"restaurant\" or \"gas_station\") in Place Types (https://developers.google.com/maps/documentation/places/web-service/place-types), or only `(regions)`, or only `(cities)`. A Place is only returned if its primary type is included in this list. Up to 5 values can be specified. If no types are specified, all Place types are returned.", "items": { "type": "string" }, diff --git a/DiscoveryJson/recaptchaenterprise_v1.json b/DiscoveryJson/recaptchaenterprise_v1.json index 0f520928e4..daaed55e35 100644 --- a/DiscoveryJson/recaptchaenterprise_v1.json +++ b/DiscoveryJson/recaptchaenterprise_v1.json @@ -694,7 +694,7 @@ } } }, - "revision": "20240324", + "revision": "20240518", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -948,6 +948,11 @@ "readOnly": true, "type": "string" }, + "phoneFraudAssessment": { + "$ref": "GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment", + "description": "Output only. Assessment returned when a site key, a token, and a phone number as `user_id` are provided. Account defender and SMS toll fraud protection need to be enabled.", + "readOnly": true + }, "privatePasswordLeakVerification": { "$ref": "GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification", "description": "Optional. The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials." @@ -1542,6 +1547,18 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment": { + "description": "Assessment for Phone Fraud", + "id": "GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment", + "properties": { + "smsTollFraudVerdict": { + "$ref": "GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict", + "description": "Output only. Assessment of this phone event for risk of sms toll fraud.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification": { "description": "Private password leak verification info.", "id": "GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification", @@ -1763,6 +1780,35 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict": { + "description": "Information about sms toll fraud", + "id": "GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict", + "properties": { + "reasons": { + "description": "Output only. Reasons contributing to the SMS toll fraud verdict.", + "items": { + "enum": [ + "SMS_TOLL_FRAUD_REASON_UNSPECIFIED", + "INVALID_PHONE_NUMBER" + ], + "enumDescriptions": [ + "Default unspecified reason", + "The provided phone number was invalid" + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "risk": { + "description": "Output only. Probability of an sms event being fraudulent. Values are from 0.0 (lowest) to 1.0 (highest).", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1TestingOptions": { "description": "Options for user acceptance testing.", "id": "GoogleCloudRecaptchaenterpriseV1TestingOptions", diff --git a/DiscoveryJson/redis_v1.json b/DiscoveryJson/redis_v1.json index eb8b046945..033a6234d8 100644 --- a/DiscoveryJson/redis_v1.json +++ b/DiscoveryJson/redis_v1.json @@ -821,7 +821,7 @@ } } }, - "revision": "20240425", + "revision": "20240509", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1403,7 +1403,11 @@ "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", - "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES", + "SIGNAL_TYPE_SUPERUSER_WRITING_TO_USER_TABLES", + "SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS", + "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", + "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET" ], "enumDeprecated": [ false, @@ -1472,6 +1476,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -1541,7 +1549,11 @@ "Performance impact of connections settings", "Performance impact of temporary tables settings", "Performance impact of transaction logs settings", - "Performance impact of high joins without indexes" + "Performance impact of high joins without indexes", + "Detects events where a Cloud SQL superuser (postgres for PostgreSQL servers or root for MySQL users) writes to non-system tables.", + "Detects events where a database user or role has been granted all privileges to a database, or to all tables, procedures, or functions in a schema.", + "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", + "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible." ], "type": "string" }, @@ -1882,7 +1894,11 @@ "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", - "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES", + "SIGNAL_TYPE_SUPERUSER_WRITING_TO_USER_TABLES", + "SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS", + "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", + "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET" ], "enumDeprecated": [ false, @@ -1951,6 +1967,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2020,7 +2040,11 @@ "Performance impact of connections settings", "Performance impact of temporary tables settings", "Performance impact of transaction logs settings", - "Performance impact of high joins without indexes" + "Performance impact of high joins without indexes", + "Detects events where a Cloud SQL superuser (postgres for PostgreSQL servers or root for MySQL users) writes to non-system tables.", + "Detects events where a database user or role has been granted all privileges to a database, or to all tables, procedures, or functions in a schema.", + "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", + "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible." ], "type": "string" } diff --git a/DiscoveryJson/redis_v1beta1.json b/DiscoveryJson/redis_v1beta1.json index 27ff6d115e..2cbcc65a27 100644 --- a/DiscoveryJson/redis_v1beta1.json +++ b/DiscoveryJson/redis_v1beta1.json @@ -821,7 +821,7 @@ } } }, - "revision": "20240425", + "revision": "20240509", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1403,7 +1403,11 @@ "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", - "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES", + "SIGNAL_TYPE_SUPERUSER_WRITING_TO_USER_TABLES", + "SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS", + "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", + "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET" ], "enumDeprecated": [ false, @@ -1472,6 +1476,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -1541,7 +1549,11 @@ "Performance impact of connections settings", "Performance impact of temporary tables settings", "Performance impact of transaction logs settings", - "Performance impact of high joins without indexes" + "Performance impact of high joins without indexes", + "Detects events where a Cloud SQL superuser (postgres for PostgreSQL servers or root for MySQL users) writes to non-system tables.", + "Detects events where a database user or role has been granted all privileges to a database, or to all tables, procedures, or functions in a schema.", + "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", + "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible." ], "type": "string" }, @@ -1882,7 +1894,11 @@ "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", - "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES", + "SIGNAL_TYPE_SUPERUSER_WRITING_TO_USER_TABLES", + "SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS", + "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", + "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET" ], "enumDeprecated": [ false, @@ -1951,6 +1967,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -2020,7 +2040,11 @@ "Performance impact of connections settings", "Performance impact of temporary tables settings", "Performance impact of transaction logs settings", - "Performance impact of high joins without indexes" + "Performance impact of high joins without indexes", + "Detects events where a Cloud SQL superuser (postgres for PostgreSQL servers or root for MySQL users) writes to non-system tables.", + "Detects events where a database user or role has been granted all privileges to a database, or to all tables, procedures, or functions in a schema.", + "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", + "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible." ], "type": "string" } diff --git a/DiscoveryJson/servicenetworking_v1.json b/DiscoveryJson/servicenetworking_v1.json index 3b7e272e28..55f78c2a43 100644 --- a/DiscoveryJson/servicenetworking_v1.json +++ b/DiscoveryJson/servicenetworking_v1.json @@ -1029,7 +1029,7 @@ } } }, - "revision": "20240424", + "revision": "20240521", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -3219,7 +3219,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/compute.xpnAdmin' applied on the shared VPC host project - 'roles/dns.admin' 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/compute.xpnAdmin' 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", "type": "string" } }, diff --git a/DiscoveryJson/servicenetworking_v1beta.json b/DiscoveryJson/servicenetworking_v1beta.json index 3ce50d200b..948b2127d7 100644 --- a/DiscoveryJson/servicenetworking_v1beta.json +++ b/DiscoveryJson/servicenetworking_v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20240424", + "revision": "20240521", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -2243,7 +2243,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/compute.xpnAdmin' applied on the shared VPC host project - 'roles/dns.admin' 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/compute.xpnAdmin' 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", "type": "string" } }, diff --git a/DiscoveryJson/sheets_v4.json b/DiscoveryJson/sheets_v4.json index 0420327efa..7174fe8311 100644 --- a/DiscoveryJson/sheets_v4.json +++ b/DiscoveryJson/sheets_v4.json @@ -870,7 +870,7 @@ } } }, - "revision": "20240430", + "revision": "20240514", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -5904,7 +5904,7 @@ "type": "object" }, "RefreshCancellationStatus": { - "description": "The status of a refresh cancellation. You can send cancel request to explicitly cancel one or multiple data source object refreshes.", + "description": "The status of a refresh cancellation. You can send a cancel request to explicitly cancel one or multiple data source object refreshes.", "id": "RefreshCancellationStatus", "properties": { "errorCode": { diff --git a/DiscoveryJson/sourcerepo_v1.json b/DiscoveryJson/sourcerepo_v1.json index f89854934b..11a7df22b7 100644 --- a/DiscoveryJson/sourcerepo_v1.json +++ b/DiscoveryJson/sourcerepo_v1.json @@ -21,9 +21,9 @@ "baseUrl": "https://sourcerepo.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Source Repositories", - "description": "Accesses source code repositories hosted by Google.", + "description": "Accesses source code repositories hosted by Google. Important: Cloud Source Repositories is scheduled for end of sales starting June 17, 2024. Customers who have enabled the API prior to this date will not be affected and can continue to use Cloud Source Repositories. Organizations or projects who have not previously enabled the API cannot use Cloud Source Repositories after this date. View Cloud Source Repositories documentation for more info. ", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/source-repositories/docs/apis", + "documentationLink": "https://cloud.google.com/source-repositories/docs", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -450,7 +450,7 @@ } } }, - "revision": "20240228", + "revision": "20240520", "rootUrl": "https://sourcerepo.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/DiscoveryJson/workstations_v1beta.json b/DiscoveryJson/workstations_v1beta.json index bd2ddbd503..ebe28c6cd7 100644 --- a/DiscoveryJson/workstations_v1beta.json +++ b/DiscoveryJson/workstations_v1beta.json @@ -1127,7 +1127,7 @@ } } }, - "revision": "20240424", + "revision": "20240508", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1849,6 +1849,23 @@ }, "type": "object" }, + "PortRange": { + "description": "A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be same.", + "id": "PortRange", + "properties": { + "first": { + "description": "Required. Starting port number for the current range of ports.", + "format": "int32", + "type": "integer" + }, + "last": { + "description": "Required. Ending port number for the current range of ports.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "PrivateClusterConfig": { "description": "Configuration options for private workstation clusters.", "id": "PrivateClusterConfig", @@ -2200,6 +2217,13 @@ "description": "A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers.", "id": "WorkstationConfig", "properties": { + "allowedPorts": { + "description": "Optional. Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535.", + "items": { + "$ref": "PortRange" + }, + "type": "array" + }, "annotations": { "additionalProperties": { "type": "string" diff --git a/Src/Generated/Google.Apis.Admin.Directory.directory_v1/Google.Apis.Admin.Directory.directory_v1.csproj b/Src/Generated/Google.Apis.Admin.Directory.directory_v1/Google.Apis.Admin.Directory.directory_v1.csproj index b3378c45c4..57d3ae0956 100644 --- a/Src/Generated/Google.Apis.Admin.Directory.directory_v1/Google.Apis.Admin.Directory.directory_v1.csproj +++ b/Src/Generated/Google.Apis.Admin.Directory.directory_v1/Google.Apis.Admin.Directory.directory_v1.csproj @@ -3,7 +3,7 @@ Google.Apis.Admin.Directory.directory_v1 Client Library - 1.68.0.3416 + 1.68.0.3428 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.AndroidManagement.v1/Google.Apis.AndroidManagement.v1.cs b/Src/Generated/Google.Apis.AndroidManagement.v1/Google.Apis.AndroidManagement.v1.cs index 494b2c793c..6e3ae28290 100644 --- a/Src/Generated/Google.Apis.AndroidManagement.v1/Google.Apis.AndroidManagement.v1.cs +++ b/Src/Generated/Google.Apis.AndroidManagement.v1/Google.Apis.AndroidManagement.v1.cs @@ -2563,6 +2563,13 @@ public CreateRequest(Google.Apis.Services.IClientService service) : base(service InitParameters(); } + /// + /// Optional. Email address used to prefill the admin field of the enterprise signup form. This value is a + /// hint only and can be altered by the user. + /// + [Google.Apis.Util.RequestParameterAttribute("adminEmail", Google.Apis.Util.RequestParameterType.Query)] + public virtual string AdminEmail { get; set; } + /// /// The callback URL that the admin will be redirected to after successfully creating an enterprise. Before /// redirecting there the system will add a query parameter to this URL named enterpriseToken which will @@ -2590,6 +2597,14 @@ public CreateRequest(Google.Apis.Services.IClientService service) : base(service protected override void InitParameters() { base.InitParameters(); + RequestParameters.Add("adminEmail", new Google.Apis.Discovery.Parameter + { + Name = "adminEmail", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); RequestParameters.Add("callbackUrl", new Google.Apis.Discovery.Parameter { Name = "callbackUrl", @@ -3291,7 +3306,9 @@ public class ApplicationReportingSettings : Google.Apis.Requests.IDirectResponse /// Batched event logs of events from the device. public class BatchUsageLogEvents : Google.Apis.Requests.IDirectResponseSchema { - /// The name of the device in the form ‘enterprises/{enterpriseId}/devices/{deviceId}’ + /// + /// If present, the name of the device in the form ‘enterprises/{enterpriseId}/devices/{deviceId}’ + /// [Newtonsoft.Json.JsonPropertyAttribute("device")] public virtual string Device { get; set; } @@ -3339,7 +3356,8 @@ public virtual object RetrievalTime public virtual System.Collections.Generic.IList UsageLogEvents { get; set; } /// - /// The resource name of the user that owns this device in the form ‘enterprises/{enterpriseId}/users/{userId}’. + /// If present, the resource name of the user that owns this device in the form + /// ‘enterprises/{enterpriseId}/users/{userId}’. /// [Newtonsoft.Json.JsonPropertyAttribute("user")] public virtual string User { get; set; } @@ -6782,7 +6800,7 @@ public class ProvisioningInfo : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("enterprise")] public virtual string Enterprise { get; set; } - /// IMEI number of the GSM device. For example, A1000031212. + /// For corporate-owned devices, IMEI number of the GSM device. For example, A1000031212. [Newtonsoft.Json.JsonPropertyAttribute("imei")] public virtual string Imei { get; set; } @@ -6790,7 +6808,7 @@ public class ProvisioningInfo : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("managementMode")] public virtual string ManagementMode { get; set; } - /// MEID number of the CDMA device. For example, A00000292788E1. + /// For corporate-owned devices, MEID number of the CDMA device. For example, A00000292788E1. [Newtonsoft.Json.JsonPropertyAttribute("meid")] public virtual string Meid { get; set; } @@ -6806,7 +6824,7 @@ public class ProvisioningInfo : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("ownership")] public virtual string Ownership { get; set; } - /// The device serial number. + /// For corporate-owned devices, The device serial number. [Newtonsoft.Json.JsonPropertyAttribute("serialNumber")] public virtual string SerialNumber { get; set; } diff --git a/Src/Generated/Google.Apis.AndroidManagement.v1/Google.Apis.AndroidManagement.v1.csproj b/Src/Generated/Google.Apis.AndroidManagement.v1/Google.Apis.AndroidManagement.v1.csproj index fe75e48930..ad67f3326d 100644 --- a/Src/Generated/Google.Apis.AndroidManagement.v1/Google.Apis.AndroidManagement.v1.csproj +++ b/Src/Generated/Google.Apis.AndroidManagement.v1/Google.Apis.AndroidManagement.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.AndroidManagement.v1 Client Library - 1.68.0.3402 + 1.68.0.3423 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.Batch.v1/Google.Apis.Batch.v1.cs b/Src/Generated/Google.Apis.Batch.v1/Google.Apis.Batch.v1.cs index a7577e5f59..8cfe743e99 100644 --- a/Src/Generated/Google.Apis.Batch.v1/Google.Apis.Batch.v1.cs +++ b/Src/Generated/Google.Apis.Batch.v1/Google.Apis.Batch.v1.cs @@ -1543,6 +1543,10 @@ public virtual object CreationTime [Newtonsoft.Json.JsonPropertyAttribute("instancePreemptionNoticeReceived")] public virtual System.Nullable InstancePreemptionNoticeReceived { get; set; } + /// Optional. machine type of the VM + [Newtonsoft.Json.JsonPropertyAttribute("machineType")] + public virtual string MachineType { get; set; } + /// parsed contents of /etc/os-release [Newtonsoft.Json.JsonPropertyAttribute("osRelease")] public virtual System.Collections.Generic.IDictionary OsRelease { get; set; } @@ -1707,8 +1711,12 @@ public class AgentTaskSpec : Google.Apis.Requests.IDirectResponseSchema public virtual AgentEnvironment Environment { get; set; } /// - /// Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. The - /// valid value range for max_run_duration in seconds is [0, 315576000000.999999999], + /// Maximum duration the task should run before being automatically retried (if enabled) or automatically + /// failed. Format the value of this field as a time limit in seconds followed by `s`—for example, `3600s` for 1 + /// hour. The field accepts any value between 0 and the maximum listed for the `Duration` field type at + /// https://protobuf.dev/reference/protobuf/google.protobuf/#duration; however, the actual maximum run time for + /// a job will be limited to the maximum run time for a job listed at + /// https://cloud.google.com/batch/quotas#max-job-duration. /// [Newtonsoft.Json.JsonPropertyAttribute("maxRunDuration")] public virtual object MaxRunDuration { get; set; } @@ -2285,8 +2293,8 @@ public class InstancePolicy : Google.Apis.Requests.IDirectResponseSchema public class InstancePolicyOrTemplate : Google.Apis.Requests.IDirectResponseSchema { /// - /// Set this field true if users want Batch to help fetch drivers from a third party location and install them - /// for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For + /// Set this field true if you want Batch to help fetch drivers from a third party location and install them for + /// GPUs specified in `policy.accelerators` or `instance_template` on your behalf. Default is false. For /// Container-Optimized Image cases, Batch will install the accelerator driver following milestones of /// https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, /// following @@ -3202,11 +3210,11 @@ public class TaskExecution : Google.Apis.Requests.IDirectResponseSchema { /// /// The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not - /// due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: - - /// Batch known failures as https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. - Batch - /// runnable execution failures: You can rely on Batch logs for further diagnose: + /// due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * + /// Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch + /// runnable execution failures; you can rely on Batch logs to further diagnose: /// https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch - /// only exposes the first error caught for now. + /// only exposes the first error. /// [Newtonsoft.Json.JsonPropertyAttribute("exitCode")] public virtual System.Nullable ExitCode { get; set; } @@ -3338,8 +3346,12 @@ public class TaskSpec : Google.Apis.Requests.IDirectResponseSchema public virtual System.Nullable MaxRetryCount { get; set; } /// - /// Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. The - /// valid value range for max_run_duration in seconds is [0, 315576000000.999999999], + /// Maximum duration the task should run before being automatically retried (if enabled) or automatically + /// failed. Format the value of this field as a time limit in seconds followed by `s`—for example, `3600s` for 1 + /// hour. The field accepts any value between 0 and the maximum listed for the `Duration` field type at + /// https://protobuf.dev/reference/protobuf/google.protobuf/#duration; however, the actual maximum run time for + /// a job will be limited to the maximum run time for a job listed at + /// https://cloud.google.com/batch/quotas#max-job-duration. /// [Newtonsoft.Json.JsonPropertyAttribute("maxRunDuration")] public virtual object MaxRunDuration { get; set; } diff --git a/Src/Generated/Google.Apis.Batch.v1/Google.Apis.Batch.v1.csproj b/Src/Generated/Google.Apis.Batch.v1/Google.Apis.Batch.v1.csproj index 307cb01c8e..eebec8f888 100644 --- a/Src/Generated/Google.Apis.Batch.v1/Google.Apis.Batch.v1.csproj +++ b/Src/Generated/Google.Apis.Batch.v1/Google.Apis.Batch.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.Batch.v1 Client Library - 1.68.0.3402 + 1.68.0.3424 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.Bigquery.v2/Google.Apis.Bigquery.v2.cs b/Src/Generated/Google.Apis.Bigquery.v2/Google.Apis.Bigquery.v2.cs index ae1a1b0086..b9a0809cd8 100644 --- a/Src/Generated/Google.Apis.Bigquery.v2/Google.Apis.Bigquery.v2.cs +++ b/Src/Generated/Google.Apis.Bigquery.v2/Google.Apis.Bigquery.v2.cs @@ -11646,10 +11646,7 @@ public class TableReplicationInfo : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("replicationError")] public virtual ErrorProto ReplicationError { get; set; } - /// - /// Optional. Specifies the interval at which the source table is polled for updates. It's Optional. If not - /// specified, default replication interval would be applied. - /// + /// Required. Specifies the interval at which the source table is polled for updates. [Newtonsoft.Json.JsonPropertyAttribute("replicationIntervalMs")] public virtual System.Nullable ReplicationIntervalMs { get; set; } diff --git a/Src/Generated/Google.Apis.Bigquery.v2/Google.Apis.Bigquery.v2.csproj b/Src/Generated/Google.Apis.Bigquery.v2/Google.Apis.Bigquery.v2.csproj index a3629833b0..a29c24f871 100644 --- a/Src/Generated/Google.Apis.Bigquery.v2/Google.Apis.Bigquery.v2.csproj +++ b/Src/Generated/Google.Apis.Bigquery.v2/Google.Apis.Bigquery.v2.csproj @@ -3,7 +3,7 @@ Google.Apis.Bigquery.v2 Client Library - 1.68.0.3400 + 1.68.0.3395 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.CloudAlloyDBAdmin.v1/Google.Apis.CloudAlloyDBAdmin.v1.cs b/Src/Generated/Google.Apis.CloudAlloyDBAdmin.v1/Google.Apis.CloudAlloyDBAdmin.v1.cs index 493a72ad1b..a05eec2ff5 100644 --- a/Src/Generated/Google.Apis.CloudAlloyDBAdmin.v1/Google.Apis.CloudAlloyDBAdmin.v1.cs +++ b/Src/Generated/Google.Apis.CloudAlloyDBAdmin.v1/Google.Apis.CloudAlloyDBAdmin.v1.cs @@ -5809,6 +5809,9 @@ public virtual object FeedTimestamp public virtual string FeedType { get; set; } /// More feed data would be added in subsequent CLs + [Newtonsoft.Json.JsonPropertyAttribute("observabilityMetricData")] + public virtual StorageDatabasecenterPartnerapiV1mainObservabilityMetricData ObservabilityMetricData { get; set; } + [Newtonsoft.Json.JsonPropertyAttribute("recommendationSignalData")] public virtual StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData RecommendationSignalData { get; set; } @@ -6054,6 +6057,10 @@ public virtual object CreationTime [Newtonsoft.Json.JsonPropertyAttribute("location")] public virtual string Location { get; set; } + /// Machine configuration for this resource. + [Newtonsoft.Json.JsonPropertyAttribute("machineConfiguration")] + public virtual StorageDatabasecenterPartnerapiV1mainMachineConfiguration MachineConfiguration { get; set; } + /// /// Identifier for this resource's immediate parent/primary resource if the current resource is a replica or /// derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists @@ -6237,6 +6244,81 @@ public class StorageDatabasecenterPartnerapiV1mainEntitlement : Google.Apis.Requ public virtual string ETag { get; set; } } + /// MachineConfiguration describes the configuration of a machine specific to Database Resource. + public class StorageDatabasecenterPartnerapiV1mainMachineConfiguration : Google.Apis.Requests.IDirectResponseSchema + { + /// The number of CPUs. + [Newtonsoft.Json.JsonPropertyAttribute("cpuCount")] + public virtual System.Nullable CpuCount { get; set; } + + /// Memory size in bytes. + [Newtonsoft.Json.JsonPropertyAttribute("memorySizeInBytes")] + public virtual System.Nullable MemorySizeInBytes { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + + public class StorageDatabasecenterPartnerapiV1mainObservabilityMetricData : Google.Apis.Requests.IDirectResponseSchema + { + private string _metricTimestampRaw; + + private object _metricTimestamp; + + /// Required. The timestamp of the metric value. + [Newtonsoft.Json.JsonPropertyAttribute("metricTimestamp")] + public virtual string MetricTimestampRaw + { + get => _metricTimestampRaw; + set + { + _metricTimestamp = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value); + _metricTimestampRaw = value; + } + } + + /// representation of . + [Newtonsoft.Json.JsonIgnoreAttribute] + [System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use MetricTimestampDateTimeOffset instead.")] + public virtual object MetricTimestamp + { + get => _metricTimestamp; + set + { + _metricTimestampRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value); + _metricTimestamp = value; + } + } + + /// + /// representation of . + /// + [Newtonsoft.Json.JsonIgnoreAttribute] + public virtual System.DateTimeOffset? MetricTimestampDateTimeOffset + { + get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(MetricTimestampRaw); + set => MetricTimestampRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value); + } + + /// Required. Type of metric like CPU, Memory, etc. + [Newtonsoft.Json.JsonPropertyAttribute("metricType")] + public virtual string MetricType { get; set; } + + /// + /// Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name + /// format as noted here go/condor-common-datamodel + /// + [Newtonsoft.Json.JsonPropertyAttribute("resourceName")] + public virtual string ResourceName { get; set; } + + /// Required. Value of the metric type. + [Newtonsoft.Json.JsonPropertyAttribute("value")] + public virtual System.Nullable Value { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + /// An error that occurred during a backup creation operation. public class StorageDatabasecenterPartnerapiV1mainOperationError : Google.Apis.Requests.IDirectResponseSchema { diff --git a/Src/Generated/Google.Apis.CloudAlloyDBAdmin.v1/Google.Apis.CloudAlloyDBAdmin.v1.csproj b/Src/Generated/Google.Apis.CloudAlloyDBAdmin.v1/Google.Apis.CloudAlloyDBAdmin.v1.csproj index 6e37b4a92a..3ba869ce9c 100644 --- a/Src/Generated/Google.Apis.CloudAlloyDBAdmin.v1/Google.Apis.CloudAlloyDBAdmin.v1.csproj +++ b/Src/Generated/Google.Apis.CloudAlloyDBAdmin.v1/Google.Apis.CloudAlloyDBAdmin.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.CloudAlloyDBAdmin.v1 Client Library - 1.68.0.3401 + 1.68.0.3424 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.CloudBuild.v1/Google.Apis.CloudBuild.v1.cs b/Src/Generated/Google.Apis.CloudBuild.v1/Google.Apis.CloudBuild.v1.cs index 19477bf794..9df544f535 100644 --- a/Src/Generated/Google.Apis.CloudBuild.v1/Google.Apis.CloudBuild.v1.cs +++ b/Src/Generated/Google.Apis.CloudBuild.v1/Google.Apis.CloudBuild.v1.cs @@ -6346,7 +6346,7 @@ public class BuildOptions : Google.Apis.Requests.IDirectResponseSchema /// Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space /// will be used by the operating system and build utilities. Also note that this is the minimum disk size that /// will be allocated for the build -- the build may run with a larger disk than requested. At present, the - /// maximum disk size is 2000GB; builds that request more than the maximum are rejected with an error. + /// maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. /// [Newtonsoft.Json.JsonPropertyAttribute("diskSizeGb")] public virtual System.Nullable DiskSizeGb { get; set; } diff --git a/Src/Generated/Google.Apis.CloudBuild.v1/Google.Apis.CloudBuild.v1.csproj b/Src/Generated/Google.Apis.CloudBuild.v1/Google.Apis.CloudBuild.v1.csproj index 82a7c2e5f0..db669b791c 100644 --- a/Src/Generated/Google.Apis.CloudBuild.v1/Google.Apis.CloudBuild.v1.csproj +++ b/Src/Generated/Google.Apis.CloudBuild.v1/Google.Apis.CloudBuild.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.CloudBuild.v1 Client Library - 1.68.0.3419 + 1.68.0.3426 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.CloudBuild.v2/Google.Apis.CloudBuild.v2.cs b/Src/Generated/Google.Apis.CloudBuild.v2/Google.Apis.CloudBuild.v2.cs index 41c51e9dce..9c76868607 100644 --- a/Src/Generated/Google.Apis.CloudBuild.v2/Google.Apis.CloudBuild.v2.cs +++ b/Src/Generated/Google.Apis.CloudBuild.v2/Google.Apis.CloudBuild.v2.cs @@ -2120,7 +2120,7 @@ public class BitbucketDataCenterConfig : Google.Apis.Requests.IDirectResponseSch public virtual UserCredential AuthorizerCredential { get; set; } /// - /// Required. The URI of the Bitbucket Data Center instance or cluster this connection is for. + /// Optional. The URI of the Bitbucket Data Center instance or cluster this connection is for. /// [Newtonsoft.Json.JsonPropertyAttribute("hostUri")] public virtual string HostUri { get; set; } @@ -2208,7 +2208,7 @@ public class ChildStatusReference : Google.Apis.Requests.IDirectResponseSchema /// public class Connection : Google.Apis.Requests.IDirectResponseSchema { - /// Allows clients to store small amounts of arbitrary data. + /// Optional. Allows clients to store small amounts of arbitrary data. [Newtonsoft.Json.JsonPropertyAttribute("annotations")] public virtual System.Collections.Generic.IDictionary Annotations { get; set; } @@ -2258,8 +2258,8 @@ public virtual object CreateTime } /// - /// If disabled is set to true, functionality is disabled for this connection. Repository based API methods and - /// webhooks processing for repositories in this connection will be disabled. + /// Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API + /// methods and webhooks processing for repositories in this connection will be disabled. /// [Newtonsoft.Json.JsonPropertyAttribute("disabled")] public virtual System.Nullable Disabled { get; set; } @@ -2619,13 +2619,14 @@ public virtual object ExpirationTime /// Configuration for connections to github.com. public class GitHubConfig : Google.Apis.Requests.IDirectResponseSchema { - /// GitHub App installation id. + /// Optional. GitHub App installation id. [Newtonsoft.Json.JsonPropertyAttribute("appInstallationId")] public virtual System.Nullable AppInstallationId { get; set; } /// - /// OAuth credential of the account that authorized the Cloud Build GitHub App. It is recommended to use a robot - /// account instead of a human user account. The OAuth token must be tied to the Cloud Build GitHub App. + /// Optional. OAuth credential of the account that authorized the Cloud Build GitHub App. It is recommended to + /// use a robot account instead of a human user account. The OAuth token must be tied to the Cloud Build GitHub + /// App. /// [Newtonsoft.Json.JsonPropertyAttribute("authorizerCredential")] public virtual OAuthCredential AuthorizerCredential { get; set; } @@ -2709,15 +2710,15 @@ public class GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig : Google.Apis.Requ [Newtonsoft.Json.JsonPropertyAttribute("apiKey")] public virtual string ApiKey { get; set; } - /// Id of the GitHub App created from the manifest. + /// Optional. Id of the GitHub App created from the manifest. [Newtonsoft.Json.JsonPropertyAttribute("appId")] public virtual System.Nullable AppId { get; set; } - /// ID of the installation of the GitHub App. + /// Optional. ID of the installation of the GitHub App. [Newtonsoft.Json.JsonPropertyAttribute("appInstallationId")] public virtual System.Nullable AppInstallationId { get; set; } - /// The URL-friendly name of the GitHub App. + /// Optional. The URL-friendly name of the GitHub App. [Newtonsoft.Json.JsonPropertyAttribute("appSlug")] public virtual string AppSlug { get; set; } @@ -2726,7 +2727,7 @@ public class GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig : Google.Apis.Requ public virtual string HostUri { get; set; } /// - /// SecretManager resource containing the private key of the GitHub App, formatted as + /// Optional. SecretManager resource containing the private key of the GitHub App, formatted as /// `projects/*/secrets/*/versions/*`. /// [Newtonsoft.Json.JsonPropertyAttribute("privateKeySecretVersion")] @@ -2737,19 +2738,20 @@ public class GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig : Google.Apis.Requ public virtual string ServerVersion { get; set; } /// - /// Configuration for using Service Directory to privately connect to a GitHub Enterprise server. This should - /// only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If - /// this field is left empty, calls to the GitHub Enterprise server will be made over the public internet. + /// Optional. Configuration for using Service Directory to privately connect to a GitHub Enterprise server. This + /// should only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public + /// internet. If this field is left empty, calls to the GitHub Enterprise server will be made over the public + /// internet. /// [Newtonsoft.Json.JsonPropertyAttribute("serviceDirectoryConfig")] public virtual GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig ServiceDirectoryConfig { get; set; } - /// SSL certificate to use for requests to GitHub Enterprise. + /// Optional. SSL certificate to use for requests to GitHub Enterprise. [Newtonsoft.Json.JsonPropertyAttribute("sslCa")] public virtual string SslCa { get; set; } /// - /// SecretManager resource containing the webhook secret of the GitHub App, formatted as + /// Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as /// `projects/*/secrets/*/versions/*`. /// [Newtonsoft.Json.JsonPropertyAttribute("webhookSecretSecretVersion")] @@ -2767,8 +2769,8 @@ public class GoogleDevtoolsCloudbuildV2GitLabConfig : Google.Apis.Requests.IDire public virtual UserCredential AuthorizerCredential { get; set; } /// - /// The URI of the GitLab Enterprise host this connection is for. If not specified, the default value is - /// https://gitlab.com. + /// Optional. The URI of the GitLab Enterprise host this connection is for. If not specified, the default value + /// is https://gitlab.com. /// [Newtonsoft.Json.JsonPropertyAttribute("hostUri")] public virtual string HostUri { get; set; } @@ -2782,14 +2784,15 @@ public class GoogleDevtoolsCloudbuildV2GitLabConfig : Google.Apis.Requests.IDire public virtual string ServerVersion { get; set; } /// - /// Configuration for using Service Directory to privately connect to a GitLab Enterprise server. This should - /// only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public internet. If - /// this field is left empty, calls to the GitLab Enterprise server will be made over the public internet. + /// Optional. Configuration for using Service Directory to privately connect to a GitLab Enterprise server. This + /// should only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public + /// internet. If this field is left empty, calls to the GitLab Enterprise server will be made over the public + /// internet. /// [Newtonsoft.Json.JsonPropertyAttribute("serviceDirectoryConfig")] public virtual GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig ServiceDirectoryConfig { get; set; } - /// SSL certificate to use for requests to GitLab Enterprise. + /// Optional. SSL certificate to use for requests to GitLab Enterprise. [Newtonsoft.Json.JsonPropertyAttribute("sslCa")] public virtual string SslCa { get; set; } @@ -3066,8 +3069,8 @@ public class Location : Google.Apis.Requests.IDirectResponseSchema public class OAuthCredential : Google.Apis.Requests.IDirectResponseSchema { /// - /// A SecretManager resource containing the OAuth token that authorizes the Cloud Build connection. Format: - /// `projects/*/secrets/*/versions/*`. + /// Optional. A SecretManager resource containing the OAuth token that authorizes the Cloud Build connection. + /// Format: `projects/*/secrets/*/versions/*`. /// [Newtonsoft.Json.JsonPropertyAttribute("oauthTokenSecretVersion")] public virtual string OauthTokenSecretVersion { get; set; } @@ -3901,7 +3904,7 @@ public class Provenance : Google.Apis.Requests.IDirectResponseSchema /// A repository associated to a parent connection. public class Repository : Google.Apis.Requests.IDirectResponseSchema { - /// Allows clients to store small amounts of arbitrary data. + /// Optional. Allows clients to store small amounts of arbitrary data. [Newtonsoft.Json.JsonPropertyAttribute("annotations")] public virtual System.Collections.Generic.IDictionary Annotations { get; set; } diff --git a/Src/Generated/Google.Apis.CloudBuild.v2/Google.Apis.CloudBuild.v2.csproj b/Src/Generated/Google.Apis.CloudBuild.v2/Google.Apis.CloudBuild.v2.csproj index 534c901210..8adbfc17d0 100644 --- a/Src/Generated/Google.Apis.CloudBuild.v2/Google.Apis.CloudBuild.v2.csproj +++ b/Src/Generated/Google.Apis.CloudBuild.v2/Google.Apis.CloudBuild.v2.csproj @@ -3,7 +3,7 @@ Google.Apis.CloudBuild.v2 Client Library - 1.68.0.3404 + 1.68.0.3426 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.CloudComposer.v1/Google.Apis.CloudComposer.v1.cs b/Src/Generated/Google.Apis.CloudComposer.v1/Google.Apis.CloudComposer.v1.cs index 6036afeb0e..d7eb110766 100644 --- a/Src/Generated/Google.Apis.CloudComposer.v1/Google.Apis.CloudComposer.v1.cs +++ b/Src/Generated/Google.Apis.CloudComposer.v1/Google.Apis.CloudComposer.v1.cs @@ -1129,6 +1129,71 @@ protected override void InitParameters() } } + /// + /// Check if an upgrade operation on the environment will succeed. In case of problems detailed info can + /// be found in the returned Operation. + /// + /// The body of the request. + /// + /// Required. The resource name of the environment to check upgrade for, in the form: + /// "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + /// + public virtual CheckUpgradeRequest CheckUpgrade(Google.Apis.CloudComposer.v1.Data.CheckUpgradeRequest body, string environment) + { + return new CheckUpgradeRequest(this.service, body, environment); + } + + /// + /// Check if an upgrade operation on the environment will succeed. In case of problems detailed info can + /// be found in the returned Operation. + /// + public class CheckUpgradeRequest : CloudComposerBaseServiceRequest + { + /// Constructs a new CheckUpgrade request. + public CheckUpgradeRequest(Google.Apis.Services.IClientService service, Google.Apis.CloudComposer.v1.Data.CheckUpgradeRequest body, string environment) : base(service) + { + Environment = environment; + Body = body; + InitParameters(); + } + + /// + /// Required. The resource name of the environment to check upgrade for, in the form: + /// "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + /// + [Google.Apis.Util.RequestParameterAttribute("environment", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Environment { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.CloudComposer.v1.Data.CheckUpgradeRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "checkUpgrade"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+environment}:checkUpgrade"; + + /// Initializes CheckUpgrade parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("environment", new Google.Apis.Discovery.Parameter + { + Name = "environment", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + }); + } + } + /// Create a new environment. /// The body of the request. /// @@ -2260,6 +2325,31 @@ public class AllowedIpRange : Google.Apis.Requests.IDirectResponseSchema public virtual string ETag { get; set; } } + /// Request to check whether image upgrade will succeed. + public class CheckUpgradeRequest : Google.Apis.Requests.IDirectResponseSchema + { + /// + /// Optional. The version of the software running in the environment. This encapsulates both the version of + /// Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression + /// `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`. + /// When used as input, the server also checks if the provided version is supported and denies the request for + /// an unsupported version. The Cloud Composer portion of the image version is a full [semantic + /// version](https://semver.org), or an alias in the form of major version number or `latest`. When an alias is + /// provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The + /// Apache Airflow portion of the image version is a full semantic version that points to one of the supported + /// Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an + /// alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias + /// and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in + /// the same field. See also [version list](/composer/docs/concepts/versioning/composer-versions) and + /// [versioning overview](/composer/docs/concepts/versioning/composer-versioning-overview). + /// + [Newtonsoft.Json.JsonPropertyAttribute("imageVersion")] + public virtual string ImageVersion { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + /// Message containing information about the result of an upgrade check operation. public class CheckUpgradeResponse : Google.Apis.Requests.IDirectResponseSchema { diff --git a/Src/Generated/Google.Apis.CloudComposer.v1/Google.Apis.CloudComposer.v1.csproj b/Src/Generated/Google.Apis.CloudComposer.v1/Google.Apis.CloudComposer.v1.csproj index 44ecba4d46..6ab4bb37bf 100644 --- a/Src/Generated/Google.Apis.CloudComposer.v1/Google.Apis.CloudComposer.v1.csproj +++ b/Src/Generated/Google.Apis.CloudComposer.v1/Google.Apis.CloudComposer.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.CloudComposer.v1 Client Library - 1.68.0.3363 + 1.68.0.3427 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.CloudFilestore.v1/Google.Apis.CloudFilestore.v1.cs b/Src/Generated/Google.Apis.CloudFilestore.v1/Google.Apis.CloudFilestore.v1.cs index 1cf692f561..64d76655f4 100644 --- a/Src/Generated/Google.Apis.CloudFilestore.v1/Google.Apis.CloudFilestore.v1.cs +++ b/Src/Generated/Google.Apis.CloudFilestore.v1/Google.Apis.CloudFilestore.v1.cs @@ -2826,10 +2826,6 @@ public virtual object CreateTime [Newtonsoft.Json.JsonPropertyAttribute("networks")] public virtual System.Collections.Generic.IList Networks { get; set; } - /// Optional. Replicaition configuration. - [Newtonsoft.Json.JsonPropertyAttribute("replication")] - public virtual Replication Replication { get; set; } - /// Output only. Reserved for future use. [Newtonsoft.Json.JsonPropertyAttribute("satisfiesPzi")] public virtual System.Nullable SatisfiesPzi { get; set; } @@ -3362,84 +3358,6 @@ public virtual object EndTime public virtual string ETag { get; set; } } - /// Replica configuration for the instance. - public class ReplicaConfig : Google.Apis.Requests.IDirectResponseSchema - { - private string _lastActiveSyncTimeRaw; - - private object _lastActiveSyncTime; - - /// - /// Output only. The timestamp of the latest replication snapshot taken on the active instance and is already - /// replicated safely. - /// - [Newtonsoft.Json.JsonPropertyAttribute("lastActiveSyncTime")] - public virtual string LastActiveSyncTimeRaw - { - get => _lastActiveSyncTimeRaw; - set - { - _lastActiveSyncTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value); - _lastActiveSyncTimeRaw = value; - } - } - - /// representation of . - [Newtonsoft.Json.JsonIgnoreAttribute] - [System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use LastActiveSyncTimeDateTimeOffset instead.")] - public virtual object LastActiveSyncTime - { - get => _lastActiveSyncTime; - set - { - _lastActiveSyncTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value); - _lastActiveSyncTime = value; - } - } - - /// - /// representation of . - /// - [Newtonsoft.Json.JsonIgnoreAttribute] - public virtual System.DateTimeOffset? LastActiveSyncTimeDateTimeOffset - { - get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(LastActiveSyncTimeRaw); - set => LastActiveSyncTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value); - } - - /// Optional. The peer instance. - [Newtonsoft.Json.JsonPropertyAttribute("peerInstance")] - public virtual string PeerInstance { get; set; } - - /// Output only. The replica state. - [Newtonsoft.Json.JsonPropertyAttribute("state")] - public virtual string State { get; set; } - - /// Output only. Additional information about the replication state, if available. - [Newtonsoft.Json.JsonPropertyAttribute("stateReasons")] - public virtual System.Collections.Generic.IList StateReasons { get; set; } - - /// The ETag of the item. - public virtual string ETag { get; set; } - } - - /// Replication specifications. - public class Replication : Google.Apis.Requests.IDirectResponseSchema - { - /// - /// Optional. Replicas configuration on the instance. For now, only a single replica config is supported. - /// - [Newtonsoft.Json.JsonPropertyAttribute("replicas")] - public virtual System.Collections.Generic.IList Replicas { get; set; } - - /// Optional. The replication role. - [Newtonsoft.Json.JsonPropertyAttribute("role")] - public virtual string Role { get; set; } - - /// The ETag of the item. - public virtual string ETag { get; set; } - } - /// RestoreInstanceRequest restores an existing instance's file share from a backup. public class RestoreInstanceRequest : Google.Apis.Requests.IDirectResponseSchema { diff --git a/Src/Generated/Google.Apis.CloudFilestore.v1/Google.Apis.CloudFilestore.v1.csproj b/Src/Generated/Google.Apis.CloudFilestore.v1/Google.Apis.CloudFilestore.v1.csproj index 76a8df9e5b..71d5fcde3e 100644 --- a/Src/Generated/Google.Apis.CloudFilestore.v1/Google.Apis.CloudFilestore.v1.csproj +++ b/Src/Generated/Google.Apis.CloudFilestore.v1/Google.Apis.CloudFilestore.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.CloudFilestore.v1 Client Library - 1.68.0.3418 + 1.68.0.3353 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.CloudRedis.v1/Google.Apis.CloudRedis.v1.csproj b/Src/Generated/Google.Apis.CloudRedis.v1/Google.Apis.CloudRedis.v1.csproj index fb02672cf1..9f0905ccf9 100644 --- a/Src/Generated/Google.Apis.CloudRedis.v1/Google.Apis.CloudRedis.v1.csproj +++ b/Src/Generated/Google.Apis.CloudRedis.v1/Google.Apis.CloudRedis.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.CloudRedis.v1 Client Library - 1.68.0.3402 + 1.68.0.3416 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.CloudRedis.v1beta1/Google.Apis.CloudRedis.v1beta1.csproj b/Src/Generated/Google.Apis.CloudRedis.v1beta1/Google.Apis.CloudRedis.v1beta1.csproj index 74e798d17a..fbd8285ce1 100644 --- a/Src/Generated/Google.Apis.CloudRedis.v1beta1/Google.Apis.CloudRedis.v1beta1.csproj +++ b/Src/Generated/Google.Apis.CloudRedis.v1beta1/Google.Apis.CloudRedis.v1beta1.csproj @@ -3,7 +3,7 @@ Google.Apis.CloudRedis.v1beta1 Client Library - 1.68.0.3402 + 1.68.0.3416 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.CloudSourceRepositories.v1/Google.Apis.CloudSourceRepositories.v1.csproj b/Src/Generated/Google.Apis.CloudSourceRepositories.v1/Google.Apis.CloudSourceRepositories.v1.csproj index 6e38d08bf2..509470618f 100644 --- a/Src/Generated/Google.Apis.CloudSourceRepositories.v1/Google.Apis.CloudSourceRepositories.v1.csproj +++ b/Src/Generated/Google.Apis.CloudSourceRepositories.v1/Google.Apis.CloudSourceRepositories.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.CloudSourceRepositories.v1 Client Library - 1.68.0.3345 + 1.68.0.3427 Google LLC Copyright 2024 Google LLC Google @@ -17,7 +17,7 @@ Google APIs Client Library for working with Sourcerepo v1. Product documentation is available at: - https://cloud.google.com/source-repositories/docs/apis + https://cloud.google.com/source-repositories/docs API reference documentation for this package is available at: https://googleapis.dev/dotnet/Google.Apis.CloudSourceRepositories.v1/latest/api/Google.Apis.CloudSourceRepositories.v1.html diff --git a/Src/Generated/Google.Apis.CloudWorkstations.v1beta/Google.Apis.CloudWorkstations.v1beta.cs b/Src/Generated/Google.Apis.CloudWorkstations.v1beta/Google.Apis.CloudWorkstations.v1beta.cs index 499b156dcf..7f8be503de 100644 --- a/Src/Generated/Google.Apis.CloudWorkstations.v1beta/Google.Apis.CloudWorkstations.v1beta.cs +++ b/Src/Generated/Google.Apis.CloudWorkstations.v1beta/Google.Apis.CloudWorkstations.v1beta.cs @@ -3571,6 +3571,24 @@ public class Policy : Google.Apis.Requests.IDirectResponseSchema public virtual System.Nullable Version { get; set; } } + /// + /// A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first + /// and last should be same. + /// + public class PortRange : Google.Apis.Requests.IDirectResponseSchema + { + /// Required. Starting port number for the current range of ports. + [Newtonsoft.Json.JsonPropertyAttribute("first")] + public virtual System.Nullable First { get; set; } + + /// Required. Ending port number for the current range of ports. + [Newtonsoft.Json.JsonPropertyAttribute("last")] + public virtual System.Nullable Last { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + /// Configuration options for private workstation clusters. public class PrivateClusterConfig : Google.Apis.Requests.IDirectResponseSchema { @@ -4158,6 +4176,13 @@ public virtual object UpdateTime /// public class WorkstationConfig : Google.Apis.Requests.IDirectResponseSchema { + /// + /// Optional. Single or Range of ports externally accessible in the workstation. If not specified defaults to + /// ports 22, 80 and ports 1024-65535. + /// + [Newtonsoft.Json.JsonPropertyAttribute("allowedPorts")] + public virtual System.Collections.Generic.IList AllowedPorts { get; set; } + /// Optional. Client-specified annotations. [Newtonsoft.Json.JsonPropertyAttribute("annotations")] public virtual System.Collections.Generic.IDictionary Annotations { get; set; } diff --git a/Src/Generated/Google.Apis.CloudWorkstations.v1beta/Google.Apis.CloudWorkstations.v1beta.csproj b/Src/Generated/Google.Apis.CloudWorkstations.v1beta/Google.Apis.CloudWorkstations.v1beta.csproj index 44161d6414..f3b74122ec 100644 --- a/Src/Generated/Google.Apis.CloudWorkstations.v1beta/Google.Apis.CloudWorkstations.v1beta.csproj +++ b/Src/Generated/Google.Apis.CloudWorkstations.v1beta/Google.Apis.CloudWorkstations.v1beta.csproj @@ -3,7 +3,7 @@ Google.Apis.CloudWorkstations.v1beta Client Library - 1.68.0.3401 + 1.68.0.3415 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.Cloudbilling.v1/Google.Apis.Cloudbilling.v1.cs b/Src/Generated/Google.Apis.Cloudbilling.v1/Google.Apis.Cloudbilling.v1.cs index 7a563babb2..258918847e 100644 --- a/Src/Generated/Google.Apis.Cloudbilling.v1/Google.Apis.Cloudbilling.v1.cs +++ b/Src/Generated/Google.Apis.Cloudbilling.v1/Google.Apis.Cloudbilling.v1.cs @@ -1677,7 +1677,7 @@ public SkusResource(Google.Apis.Services.IClientService service) } /// Lists all publicly available SKUs for a given cloud service. - /// Required. The name of the service. Example: "services/DA34-426B-A397" + /// Required. The name of the service. Example: "services/6F81-5844-456A" public virtual ListRequest List(string parent) { return new ListRequest(this.service, parent); @@ -1693,7 +1693,7 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : InitParameters(); } - /// Required. The name of the service. Example: "services/DA34-426B-A397" + /// Required. The name of the service. Example: "services/6F81-5844-456A" [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] public virtual string Parent { get; private set; } @@ -2560,11 +2560,11 @@ public class Service : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("displayName")] public virtual string DisplayName { get; set; } - /// The resource name for the service. Example: "services/DA34-426B-A397" + /// The resource name for the service. Example: "services/6F81-5844-456A" [Newtonsoft.Json.JsonPropertyAttribute("name")] public virtual string Name { get; set; } - /// The identifier for the service. Example: "DA34-426B-A397" + /// The identifier for the service. Example: "6F81-5844-456A" [Newtonsoft.Json.JsonPropertyAttribute("serviceId")] public virtual string ServiceId { get; set; } @@ -2594,7 +2594,7 @@ public class SetIamPolicyRequest : Google.Apis.Requests.IDirectResponseSchema public virtual string ETag { get; set; } } - /// Encapsulates a single SKU in Google Cloud Platform + /// Encapsulates a single SKU in Google Cloud public class Sku : Google.Apis.Requests.IDirectResponseSchema { /// The category hierarchy of this SKU, purely for organizational purpose. @@ -2609,7 +2609,7 @@ public class Sku : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("geoTaxonomy")] public virtual GeoTaxonomy GeoTaxonomy { get; set; } - /// The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" + /// The resource name for the SKU. Example: "services/6F81-5844-456A/skus/D041-B8A1-6E0B" [Newtonsoft.Json.JsonPropertyAttribute("name")] public virtual string Name { get; set; } @@ -2630,7 +2630,7 @@ public class Sku : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("serviceRegions")] public virtual System.Collections.Generic.IList ServiceRegions { get; set; } - /// The identifier for the SKU. Example: "AA95-CD31-42FE" + /// The identifier for the SKU. Example: "D041-B8A1-6E0B" [Newtonsoft.Json.JsonPropertyAttribute("skuId")] public virtual string SkuId { get; set; } diff --git a/Src/Generated/Google.Apis.Cloudbilling.v1/Google.Apis.Cloudbilling.v1.csproj b/Src/Generated/Google.Apis.Cloudbilling.v1/Google.Apis.Cloudbilling.v1.csproj index 991cc74a6e..b3f91f6527 100644 --- a/Src/Generated/Google.Apis.Cloudbilling.v1/Google.Apis.Cloudbilling.v1.csproj +++ b/Src/Generated/Google.Apis.Cloudbilling.v1/Google.Apis.Cloudbilling.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.Cloudbilling.v1 Client Library - 1.68.0.3305 + 1.68.0.3424 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.Contactcenterinsights.v1/Google.Apis.Contactcenterinsights.v1.cs b/Src/Generated/Google.Apis.Contactcenterinsights.v1/Google.Apis.Contactcenterinsights.v1.cs index c79f011182..666fac9f49 100644 --- a/Src/Generated/Google.Apis.Contactcenterinsights.v1/Google.Apis.Contactcenterinsights.v1.cs +++ b/Src/Generated/Google.Apis.Contactcenterinsights.v1/Google.Apis.Contactcenterinsights.v1.cs @@ -1181,7 +1181,12 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Con [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] public virtual string Name { get; private set; } - /// The list of fields to be updated. + /// + /// The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset + /// of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * + /// `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * + /// `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri` + /// [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] public virtual object UpdateMask { get; set; } diff --git a/Src/Generated/Google.Apis.Contactcenterinsights.v1/Google.Apis.Contactcenterinsights.v1.csproj b/Src/Generated/Google.Apis.Contactcenterinsights.v1/Google.Apis.Contactcenterinsights.v1.csproj index 1a2f32495a..dd0704ac0d 100644 --- a/Src/Generated/Google.Apis.Contactcenterinsights.v1/Google.Apis.Contactcenterinsights.v1.csproj +++ b/Src/Generated/Google.Apis.Contactcenterinsights.v1/Google.Apis.Contactcenterinsights.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.Contactcenterinsights.v1 Client Library - 1.68.0.3413 + 1.68.0.3427 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.DiscoveryEngine.v1/Google.Apis.DiscoveryEngine.v1.cs b/Src/Generated/Google.Apis.DiscoveryEngine.v1/Google.Apis.DiscoveryEngine.v1.cs index 7e27170187..e40f96feff 100644 --- a/Src/Generated/Google.Apis.DiscoveryEngine.v1/Google.Apis.DiscoveryEngine.v1.cs +++ b/Src/Generated/Google.Apis.DiscoveryEngine.v1/Google.Apis.DiscoveryEngine.v1.cs @@ -297,6 +297,7 @@ public LocationsResource(Google.Apis.Services.IClientService service) DataStores = new DataStoresResource(service); GroundingConfigs = new GroundingConfigsResource(service); Operations = new OperationsResource(service); + RankingConfigs = new RankingConfigsResource(service); UserEvents = new UserEventsResource(service); } @@ -517,6 +518,7 @@ public DataStoresResource(Google.Apis.Services.IClientService service) Operations = new OperationsResource(service); Schemas = new SchemasResource(service); ServingConfigs = new ServingConfigsResource(service); + Sessions = new SessionsResource(service); SiteSearchEngine = new SiteSearchEngineResource(service); SuggestionDenyListEntries = new SuggestionDenyListEntriesResource(service); UserEvents = new UserEventsResource(service); @@ -588,8 +590,8 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Di public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the Document, which will become the final component of - /// the Document.name. If the caller does not have permission to create the Document, + /// Required. The ID to use for the Document, which becomes the final component of the + /// Document.name. If the caller does not have permission to create the Document, /// regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. /// This field must be unique among all Documents with the same parent. Otherwise, an /// `ALREADY_EXISTS` error is returned. This field must conform to @@ -753,8 +755,8 @@ protected override void InitParameters() /// /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing - /// items will be created. Note: It is possible for a subset of the Documents to be - /// successfully updated. + /// items are created. Note: It is possible for a subset of the Documents to be successfully + /// updated. /// /// The body of the request. /// @@ -769,8 +771,8 @@ public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1.Data.GoogleCl /// /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing - /// items will be created. Note: It is possible for a subset of the Documents to be - /// successfully updated. + /// items are created. Note: It is possible for a subset of the Documents to be successfully + /// updated. /// public class ImportRequest : DiscoveryEngineBaseServiceRequest { @@ -856,8 +858,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// Maximum number of Documents to return. If unspecified, defaults to 100. The maximum - /// allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is - /// negative, an `INVALID_ARGUMENT` error is returned. + /// allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, + /// an `INVALID_ARGUMENT` error is returned. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -944,14 +946,14 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis public virtual string Name { get; private set; } /// - /// If set to true, and the Document is not found, a new Document will be created. + /// If set to `true` and the Document is not found, a new Document is be created. /// [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable AllowMissing { get; set; } /// - /// Indicates which fields in the provided imported 'document' to update. If not set, - /// will by default update all fields. + /// Indicates which fields in the provided imported 'document' to update. If not set, by + /// default updates all fields. /// [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] public virtual object UpdateMask { get; set; } @@ -2288,7 +2290,7 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Di public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the Schema, which will become the final component of the + /// Required. The ID to use for the Schema, which becomes the final component of the /// Schema.name. This field should conform to /// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 /// characters. @@ -2465,8 +2467,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// The maximum number of Schemas to return. The service may return fewer than this value. - /// If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values - /// above 1000 will be coerced to 1000. + /// If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values + /// above 1000 are set to 1000. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -2551,8 +2553,8 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis public virtual string Name { get; private set; } /// - /// If set to true, and the Schema is not found, a new Schema will be created. In this - /// situation, `update_mask` is ignored. + /// If set to true, and the Schema is not found, a new Schema is created. In this situation, + /// `update_mask` is ignored. /// [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable AllowMissing { get; set; } @@ -2613,14 +2615,81 @@ public ServingConfigsResource(Google.Apis.Services.IClientService service) this.service = service; } + /// Answer query method. + /// The body of the request. + /// + /// Required. The resource name of the Search serving config, such as + /// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, + /// or + /// `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. + /// This field is used to identify the serving configuration name, set of models used to make + /// the search. + /// + public virtual AnswerRequest Answer(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1AnswerQueryRequest body, string servingConfig) + { + return new AnswerRequest(this.service, body, servingConfig); + } + + /// Answer query method. + public class AnswerRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Answer request. + public AnswerRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1AnswerQueryRequest body, string servingConfig) : base(service) + { + ServingConfig = servingConfig; + Body = body; + InitParameters(); + } + + /// + /// Required. The resource name of the Search serving config, such as + /// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, + /// or + /// `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. + /// This field is used to identify the serving configuration name, set of models used to + /// make the search. + /// + [Google.Apis.Util.RequestParameterAttribute("servingConfig", Google.Apis.Util.RequestParameterType.Path)] + public virtual string ServingConfig { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1AnswerQueryRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "answer"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+servingConfig}:answer"; + + /// Initializes Answer parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("servingConfig", new Google.Apis.Discovery.Parameter + { + Name = "servingConfig", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + }); + } + } + /// Makes a recommendation, which requires a contextual user event. /// The body of the request. /// /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default - /// serving config is created along with your recommendation engine creation. The engine ID will - /// be used as the ID of the default serving config. For example, for Engine + /// serving config is created along with your recommendation engine creation. The engine ID is + /// used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for /// your RecommendationService.Recommend requests. @@ -2646,7 +2715,7 @@ public RecommendRequest(Google.Apis.Services.IClientService service, Google.Apis /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default /// serving config is created along with your recommendation engine creation. The engine ID - /// will be used as the ID of the default serving config. For example, for Engine + /// is used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` /// for your RecommendationService.Recommend requests. @@ -2752,57 +2821,53 @@ protected override void InitParameters() } } - /// Gets the SiteSearchEngine resource. - public virtual SiteSearchEngineResource SiteSearchEngine { get; } + /// Gets the Sessions resource. + public virtual SessionsResource Sessions { get; } - /// The "siteSearchEngine" collection of methods. - public class SiteSearchEngineResource + /// The "sessions" collection of methods. + public class SessionsResource { - private const string Resource = "siteSearchEngine"; + private const string Resource = "sessions"; /// The service which this resource belongs to. private readonly Google.Apis.Services.IClientService service; /// Constructs a new resource. - public SiteSearchEngineResource(Google.Apis.Services.IClientService service) + public SessionsResource(Google.Apis.Services.IClientService service) { this.service = service; - Operations = new OperationsResource(service); - TargetSites = new TargetSitesResource(service); + Answers = new AnswersResource(service); } - /// Gets the Operations resource. - public virtual OperationsResource Operations { get; } + /// Gets the Answers resource. + public virtual AnswersResource Answers { get; } - /// The "operations" collection of methods. - public class OperationsResource + /// The "answers" collection of methods. + public class AnswersResource { - private const string Resource = "operations"; + private const string Resource = "answers"; /// The service which this resource belongs to. private readonly Google.Apis.Services.IClientService service; /// Constructs a new resource. - public OperationsResource(Google.Apis.Services.IClientService service) + public AnswersResource(Google.Apis.Services.IClientService service) { this.service = service; } - /// - /// 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. - /// - /// The name of the operation resource. + /// Gets a Answer. + /// + /// Required. The resource name of the Answer to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` + /// public virtual GetRequest Get(string name) { return new GetRequest(this.service, name); } - /// - /// 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. - /// - public class GetRequest : DiscoveryEngineBaseServiceRequest + /// Gets a Answer. + public class GetRequest : DiscoveryEngineBaseServiceRequest { /// Constructs a new Get request. public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) @@ -2811,7 +2876,10 @@ public GetRequest(Google.Apis.Services.IClientService service, string name) : ba InitParameters(); } - /// The name of the operation resource. + /// + /// Required. The resource name of the Answer to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` + /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] public virtual string Name { get; private set; } @@ -2834,438 +2902,449 @@ protected override void InitParameters() IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/operations/[^/]+$", + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", }); } } + } - /// - /// Lists operations that match the specified filter in the request. If the server doesn't - /// support this method, it returns `UNIMPLEMENTED`. - /// - /// The name of the operation's parent resource. - public virtual ListRequest List(string name) + /// + /// Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is + /// returned. + /// + /// The body of the request. + /// + /// Required. Full resource name of parent data store. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string parent) + { + return new CreateRequest(this.service, body, parent); + } + + /// + /// Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is + /// returned. + /// + public class CreateRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Create request. + public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string parent) : base(service) { - return new ListRequest(this.service, name); + Parent = parent; + Body = body; + InitParameters(); } /// - /// Lists operations that match the specified filter in the request. If the server doesn't - /// support this method, it returns `UNIMPLEMENTED`. + /// Required. Full resource name of parent data store. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` /// - public class ListRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } - - /// The name of the operation's parent resource. - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } - - /// The standard list filter. - [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Filter { get; set; } + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// The standard list page size. - [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable PageSize { get; set; } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session Body { get; set; } - /// The standard list page token. - [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] - public virtual string PageToken { get; set; } + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the method name. - public override string MethodName => "list"; + /// Gets the method name. + public override string MethodName => "create"; - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Gets the HTTP method. + public override string HttpMethod => "POST"; - /// Gets the REST path. - public override string RestPath => "v1/{+name}/operations"; + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/sessions"; - /// Initializes List parameter list. - protected override void InitParameters() + /// Initializes Create parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", - }); - RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter - { - Name = "filter", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter - { - Name = "pageSize", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter - { - Name = "pageToken", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + }); } } - /// Gets the TargetSites resource. - public virtual TargetSitesResource TargetSites { get; } - - /// The "targetSites" collection of methods. - public class TargetSitesResource + /// + /// Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + /// + /// + /// Required. The resource name of the Session to delete. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + public virtual DeleteRequest Delete(string name) { - private const string Resource = "targetSites"; - - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + return new DeleteRequest(this.service, name); + } - /// Constructs a new resource. - public TargetSitesResource(Google.Apis.Services.IClientService service) + /// + /// Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + /// + public class DeleteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Delete request. + public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) { - this.service = service; - Operations = new OperationsResource(service); + Name = name; + InitParameters(); } - /// Gets the Operations resource. - public virtual OperationsResource Operations { get; } + /// + /// Required. The resource name of the Session to delete. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// The "operations" collection of methods. - public class OperationsResource - { - private const string Resource = "operations"; + /// Gets the method name. + public override string MethodName => "delete"; - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + /// Gets the HTTP method. + public override string HttpMethod => "DELETE"; - /// Constructs a new resource. - public OperationsResource(Google.Apis.Services.IClientService service) - { - this.service = service; - } + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// - /// 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. - /// - /// The name of the operation resource. - public virtual GetRequest Get(string name) + /// Initializes Delete parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - return new GetRequest(this.service, name); - } + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + }); + } + } - /// - /// 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. - /// - public class GetRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + /// Gets a Session. + /// + /// Required. The resource name of the Session to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } - /// The name of the operation resource. - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// Gets a Session. + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } - /// Gets the method name. - public override string MethodName => "get"; + /// + /// Required. The resource name of the Session to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Gets the method name. + public override string MethodName => "get"; - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Initializes Get parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/operations/[^/]+$", - }); - } - } + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// - /// Lists operations that match the specified filter in the request. If the server - /// doesn't support this method, it returns `UNIMPLEMENTED`. - /// - /// The name of the operation's parent resource. - public virtual ListRequest List(string name) + /// Initializes Get parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - return new ListRequest(this.service, name); - } + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + }); + } + } - /// - /// Lists operations that match the specified filter in the request. If the server - /// doesn't support this method, it returns `UNIMPLEMENTED`. - /// - public class ListRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + /// Lists all Sessions by their parent DataStore. + /// + /// Required. The data store resource name. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + public virtual ListRequest List(string parent) + { + return new ListRequest(this.service, parent); + } - /// The name of the operation's parent resource. - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// Lists all Sessions by their parent DataStore. + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + { + Parent = parent; + InitParameters(); + } - /// The standard list filter. - [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Filter { get; set; } + /// + /// Required. The data store resource name. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// The standard list page size. - [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable PageSize { get; set; } + /// + /// A filter to apply on the list results. The supported features are: user_pseudo_id, + /// state. Example: "user_pseudo_id = some_id" + /// + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } - /// The standard list page token. - [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] - public virtual string PageToken { get; set; } + /// + /// A comma-separated list of fields to order by, sorted in ascending order. Use "desc" + /// after a field name for descending. Supported fields: * `update_time` * `create_time` * + /// `session_name` Example: "update_time desc" "create_time" + /// + [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)] + public virtual string OrderBy { get; set; } - /// Gets the method name. - public override string MethodName => "list"; + /// + /// Maximum number of results to return. If unspecified, defaults to 50. Max allowed value + /// is 1000. + /// + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// + /// A page token, received from a previous `ListSessions` call. Provide this to retrieve the + /// subsequent page. + /// + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}/operations"; + /// Gets the method name. + public override string MethodName => "list"; - /// Initializes List parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites$", - }); - RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter - { - Name = "filter", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter - { - Name = "pageSize", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter - { - Name = "pageToken", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } - } - } + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Creates TargetSite in a batch. - /// The body of the request. - /// - /// Required. The parent resource shared by all TargetSites being created. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// The parent field in the CreateBookRequest messages must either be empty or match this - /// field. - /// - public virtual BatchCreateRequest BatchCreate(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest body, string parent) - { - return new BatchCreateRequest(this.service, body, parent); - } + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/sessions"; - /// Creates TargetSite in a batch. - public class BatchCreateRequest : DiscoveryEngineBaseServiceRequest + /// Initializes List parameter list. + protected override void InitParameters() { - /// Constructs a new BatchCreate request. - public BatchCreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest body, string parent) : base(service) + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter { - Parent = parent; - Body = body; - InitParameters(); - } - - /// - /// Required. The parent resource shared by all TargetSites being created. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// The parent field in the CreateBookRequest messages must either be empty or match - /// this field. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } - - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest Body { get; set; } - - /// Returns the body of the request. - protected override object GetBody() => Body; - - /// Gets the method name. - public override string MethodName => "batchCreate"; - - /// Gets the HTTP method. - public override string HttpMethod => "POST"; - - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/targetSites:batchCreate"; - - /// Initializes BatchCreate parameter list. - protected override void InitParameters() + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + }); + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", - }); - } + Name = "filter", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter + { + Name = "orderBy", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); } + } - /// Creates a TargetSite. - /// The body of the request. - /// - /// Required. Parent resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// - public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string parent) + /// + /// Updates a Session. Session action type cannot be changed. If the Session to update does not + /// exist, a NOT_FOUND error is returned. + /// + /// The body of the request. + /// + /// Immutable. Fully qualified name + /// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` + /// + public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string name) + { + return new PatchRequest(this.service, body, name); + } + + /// + /// Updates a Session. Session action type cannot be changed. If the Session to update does not + /// exist, a NOT_FOUND error is returned. + /// + public class PatchRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Patch request. + public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string name) : base(service) { - return new CreateRequest(this.service, body, parent); + Name = name; + Body = body; + InitParameters(); } - /// Creates a TargetSite. - public class CreateRequest : DiscoveryEngineBaseServiceRequest + /// + /// Immutable. Fully qualified name + /// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// + /// Indicates which fields in the provided Session to update. The following are NOT + /// supported: * Session.name If not set or empty, all supported fields are updated. + /// + [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] + public virtual object UpdateMask { get; set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "patch"; + + /// Gets the HTTP method. + public override string HttpMethod => "PATCH"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Patch parameter list. + protected override void InitParameters() { - /// Constructs a new Create request. - public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string parent) : base(service) + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - Parent = parent; - Body = body; - InitParameters(); - } + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + }); + RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter + { + Name = "updateMask", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + } - /// - /// Required. Parent resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// Gets the SiteSearchEngine resource. + public virtual SiteSearchEngineResource SiteSearchEngine { get; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite Body { get; set; } + /// The "siteSearchEngine" collection of methods. + public class SiteSearchEngineResource + { + private const string Resource = "siteSearchEngine"; - /// Returns the body of the request. - protected override object GetBody() => Body; + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; - /// Gets the method name. - public override string MethodName => "create"; + /// Constructs a new resource. + public SiteSearchEngineResource(Google.Apis.Services.IClientService service) + { + this.service = service; + Operations = new OperationsResource(service); + TargetSites = new TargetSitesResource(service); + } - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the Operations resource. + public virtual OperationsResource Operations { get; } - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/targetSites"; + /// The "operations" collection of methods. + public class OperationsResource + { + private const string Resource = "operations"; - /// Initializes Create parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", - }); - } + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public OperationsResource(Google.Apis.Services.IClientService service) + { + this.service = service; } - /// Deletes a TargetSite. - /// - /// Required. Full resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. - /// If the caller does not have permission to access the TargetSite, regardless of whether - /// or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite - /// does not exist, a NOT_FOUND error is returned. - /// - public virtual DeleteRequest Delete(string name) + /// + /// 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. + /// + /// The name of the operation resource. + public virtual GetRequest Get(string name) { - return new DeleteRequest(this.service, name); + return new GetRequest(this.service, name); } - /// Deletes a TargetSite. - public class DeleteRequest : DiscoveryEngineBaseServiceRequest + /// + /// 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. + /// + public class GetRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Delete request. - public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) { Name = name; InitParameters(); } - /// - /// Required. Full resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. - /// If the caller does not have permission to access the TargetSite, regardless of - /// whether or not it exists, a PERMISSION_DENIED error is returned. If the requested - /// TargetSite does not exist, a NOT_FOUND error is returned. - /// + /// The name of the operation resource. [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] public virtual string Name { get; private set; } /// Gets the method name. - public override string MethodName => "delete"; + public override string MethodName => "get"; /// Gets the HTTP method. - public override string HttpMethod => "DELETE"; + public override string HttpMethod => "GET"; /// Gets the REST path. public override string RestPath => "v1/{+name}"; - /// Initializes Delete parameter list. + /// Initializes Get parameter list. protected override void InitParameters() { base.InitParameters(); @@ -3275,115 +3354,47 @@ protected override void InitParameters() IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/operations/[^/]+$", }); } } - /// Gets a TargetSite. - /// - /// Required. Full resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. - /// If the caller does not have permission to access the TargetSite, regardless of whether - /// or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite - /// does not exist, a NOT_FOUND error is returned. - /// - public virtual GetRequest Get(string name) + /// + /// Lists operations that match the specified filter in the request. If the server doesn't + /// support this method, it returns `UNIMPLEMENTED`. + /// + /// The name of the operation's parent resource. + public virtual ListRequest List(string name) { - return new GetRequest(this.service, name); + return new ListRequest(this.service, name); } - /// Gets a TargetSite. - public class GetRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + /// + /// Lists operations that match the specified filter in the request. If the server doesn't + /// support this method, it returns `UNIMPLEMENTED`. + /// + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) { Name = name; InitParameters(); } - /// - /// Required. Full resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. - /// If the caller does not have permission to access the TargetSite, regardless of - /// whether or not it exists, a PERMISSION_DENIED error is returned. If the requested - /// TargetSite does not exist, a NOT_FOUND error is returned. - /// + /// The name of the operation's parent resource. [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] public virtual string Name { get; private set; } - /// Gets the method name. - public override string MethodName => "get"; - - /// Gets the HTTP method. - public override string HttpMethod => "GET"; - - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; - - /// Initializes Get parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", - }); - } - } - - /// Gets a list of TargetSites. - /// - /// Required. The parent site search engine resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// If the caller does not have permission to list TargetSites under this site search - /// engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is - /// returned. - /// - public virtual ListRequest List(string parent) - { - return new ListRequest(this.service, parent); - } - - /// Gets a list of TargetSites. - public class ListRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) - { - Parent = parent; - InitParameters(); - } - - /// - /// Required. The parent site search engine resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// If the caller does not have permission to list TargetSites under this site search - /// engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error - /// is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// The standard list filter. + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } - /// - /// Requested page size. Server may return fewer items than requested. If unspecified, - /// server will pick an appropriate default. The maximum value is 1000; values above - /// 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error - /// is returned. - /// + /// The standard list page size. [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } - /// - /// A page token, received from a previous `ListTargetSites` call. Provide this to - /// retrieve the subsequent page. When paginating, all other parameters provided to - /// `ListTargetSites` must match the call that provided the page token. - /// + /// The standard list page token. [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] public virtual string PageToken { get; set; } @@ -3394,20 +3405,28 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : public override string HttpMethod => "GET"; /// Gets the REST path. - public override string RestPath => "v1/{+parent}/targetSites"; + public override string RestPath => "v1/{+name}/operations"; /// Initializes List parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - Name = "parent", + Name = "name", IsRequired = true, ParameterType = "path", DefaultValue = null, Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", }); + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter + { + Name = "filter", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter { Name = "pageSize", @@ -3426,437 +3445,592 @@ protected override void InitParameters() }); } } + } - /// Updates a TargetSite. - /// The body of the request. - /// - /// Output only. The fully qualified resource name of the target site. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` - /// The `target_site_id` is system-generated. - /// - public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string name) + /// Gets the TargetSites resource. + public virtual TargetSitesResource TargetSites { get; } + + /// The "targetSites" collection of methods. + public class TargetSitesResource + { + private const string Resource = "targetSites"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public TargetSitesResource(Google.Apis.Services.IClientService service) { - return new PatchRequest(this.service, body, name); + this.service = service; + Operations = new OperationsResource(service); } - /// Updates a TargetSite. - public class PatchRequest : DiscoveryEngineBaseServiceRequest + /// Gets the Operations resource. + public virtual OperationsResource Operations { get; } + + /// The "operations" collection of methods. + public class OperationsResource { - /// Constructs a new Patch request. - public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string name) : base(service) + private const string Resource = "operations"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public OperationsResource(Google.Apis.Services.IClientService service) { - Name = name; - Body = body; - InitParameters(); + this.service = service; } /// - /// Output only. The fully qualified resource name of the target site. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` - /// The `target_site_id` is system-generated. + /// 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. /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// The name of the operation resource. + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite Body { get; set; } + /// + /// 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. + /// + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// The name of the operation resource. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the method name. - public override string MethodName => "patch"; + /// Gets the method name. + public override string MethodName => "get"; - /// Gets the HTTP method. - public override string HttpMethod => "PATCH"; + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Initializes Patch parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + /// Initializes Get parameter list. + protected override void InitParameters() { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", - }); + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/operations/[^/]+$", + }); + } } - } - } - - /// - /// Verify target sites' ownership and validity. This API sends all the target sites under site - /// search engine for verification. - /// - /// The body of the request. - /// - /// Required. The parent resource shared by all TargetSites being verified. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// - public virtual BatchVerifyTargetSitesRequest BatchVerifyTargetSites(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest body, string parent) - { - return new BatchVerifyTargetSitesRequest(this.service, body, parent); - } - /// - /// Verify target sites' ownership and validity. This API sends all the target sites under site - /// search engine for verification. - /// - public class BatchVerifyTargetSitesRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new BatchVerifyTargetSites request. - public BatchVerifyTargetSitesRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest body, string parent) : base(service) - { - Parent = parent; - Body = body; - InitParameters(); - } + /// + /// Lists operations that match the specified filter in the request. If the server + /// doesn't support this method, it returns `UNIMPLEMENTED`. + /// + /// The name of the operation's parent resource. + public virtual ListRequest List(string name) + { + return new ListRequest(this.service, name); + } - /// - /// Required. The parent resource shared by all TargetSites being verified. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// + /// Lists operations that match the specified filter in the request. If the server + /// doesn't support this method, it returns `UNIMPLEMENTED`. + /// + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest Body { get; set; } + /// The name of the operation's parent resource. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// The standard list filter. + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } - /// Gets the method name. - public override string MethodName => "batchVerifyTargetSites"; + /// The standard list page size. + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// The standard list page token. + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+parent}:batchVerifyTargetSites"; + /// Gets the method name. + public override string MethodName => "list"; - /// Initializes BatchVerifyTargetSites parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", - }); - } - } + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Downgrade from advanced site search to basic site search. - /// The body of the request. - /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. - /// - public virtual DisableAdvancedSiteSearchRequest DisableAdvancedSiteSearch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest body, string siteSearchEngine) - { - return new DisableAdvancedSiteSearchRequest(this.service, body, siteSearchEngine); - } + /// Gets the REST path. + public override string RestPath => "v1/{+name}/operations"; - /// Downgrade from advanced site search to basic site search. - public class DisableAdvancedSiteSearchRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new DisableAdvancedSiteSearch request. - public DisableAdvancedSiteSearchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest body, string siteSearchEngine) : base(service) + /// Initializes List parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites$", + }); + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter + { + Name = "filter", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + } + + /// Creates TargetSite in a batch. + /// The body of the request. + /// + /// Required. The parent resource shared by all TargetSites being created. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// The parent field in the CreateBookRequest messages must either be empty or match this + /// field. + /// + public virtual BatchCreateRequest BatchCreate(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest body, string parent) { - SiteSearchEngine = siteSearchEngine; - Body = body; - InitParameters(); + return new BatchCreateRequest(this.service, body, parent); } - /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. - /// - [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] - public virtual string SiteSearchEngine { get; private set; } + /// Creates TargetSite in a batch. + public class BatchCreateRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new BatchCreate request. + public BatchCreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest Body { get; set; } + /// + /// Required. The parent resource shared by all TargetSites being created. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// The parent field in the CreateBookRequest messages must either be empty or match + /// this field. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest Body { get; set; } - /// Gets the method name. - public override string MethodName => "disableAdvancedSiteSearch"; + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the method name. + public override string MethodName => "batchCreate"; - /// Gets the REST path. - public override string RestPath => "v1/{+siteSearchEngine}:disableAdvancedSiteSearch"; + /// Gets the HTTP method. + public override string HttpMethod => "POST"; - /// Initializes DisableAdvancedSiteSearch parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/targetSites:batchCreate"; + + /// Initializes BatchCreate parameter list. + protected override void InitParameters() { - Name = "siteSearchEngine", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", - }); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", + }); + } } - } - - /// Upgrade from basic site search to advanced site search. - /// The body of the request. - /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. - /// - public virtual EnableAdvancedSiteSearchRequest EnableAdvancedSiteSearch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest body, string siteSearchEngine) - { - return new EnableAdvancedSiteSearchRequest(this.service, body, siteSearchEngine); - } - /// Upgrade from basic site search to advanced site search. - public class EnableAdvancedSiteSearchRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new EnableAdvancedSiteSearch request. - public EnableAdvancedSiteSearchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest body, string siteSearchEngine) : base(service) + /// Creates a TargetSite. + /// The body of the request. + /// + /// Required. Parent resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// + public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string parent) { - SiteSearchEngine = siteSearchEngine; - Body = body; - InitParameters(); + return new CreateRequest(this.service, body, parent); } - /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. - /// - [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] - public virtual string SiteSearchEngine { get; private set; } + /// Creates a TargetSite. + public class CreateRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Create request. + public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest Body { get; set; } + /// + /// Required. Parent resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite Body { get; set; } - /// Gets the method name. - public override string MethodName => "enableAdvancedSiteSearch"; + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the method name. + public override string MethodName => "create"; - /// Gets the REST path. - public override string RestPath => "v1/{+siteSearchEngine}:enableAdvancedSiteSearch"; + /// Gets the HTTP method. + public override string HttpMethod => "POST"; - /// Initializes EnableAdvancedSiteSearch parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/targetSites"; + + /// Initializes Create parameter list. + protected override void InitParameters() { - Name = "siteSearchEngine", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", - }); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", + }); + } } - } - - /// - /// Returns list of target sites with its domain verification status. This method can only be - /// called under data store with BASIC_SITE_SEARCH state at the moment. - /// - /// - /// Required. The site search engine resource under which we fetch all the domain verification - /// status. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// - public virtual FetchDomainVerificationStatusRequest FetchDomainVerificationStatus(string siteSearchEngine) - { - return new FetchDomainVerificationStatusRequest(this.service, siteSearchEngine); - } - /// - /// Returns list of target sites with its domain verification status. This method can only be - /// called under data store with BASIC_SITE_SEARCH state at the moment. - /// - public class FetchDomainVerificationStatusRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new FetchDomainVerificationStatus request. - public FetchDomainVerificationStatusRequest(Google.Apis.Services.IClientService service, string siteSearchEngine) : base(service) + /// Deletes a TargetSite. + /// + /// Required. Full resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. + /// If the caller does not have permission to access the TargetSite, regardless of whether + /// or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite + /// does not exist, a NOT_FOUND error is returned. + /// + public virtual DeleteRequest Delete(string name) { - SiteSearchEngine = siteSearchEngine; - InitParameters(); + return new DeleteRequest(this.service, name); } - /// - /// Required. The site search engine resource under which we fetch all the domain - /// verification status. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// - [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] - public virtual string SiteSearchEngine { get; private set; } - - /// - /// Requested page size. Server may return fewer items than requested. If unspecified, - /// server will pick an appropriate default. The maximum value is 1000; values above 1000 - /// will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is - /// returned. - /// - [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable PageSize { get; set; } + /// Deletes a TargetSite. + public class DeleteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Delete request. + public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } - /// - /// A page token, received from a previous `FetchDomainVerificationStatus` call. Provide - /// this to retrieve the subsequent page. When paginating, all other parameters provided to - /// `FetchDomainVerificationStatus` must match the call that provided the page token. - /// - [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] - public virtual string PageToken { get; set; } + /// + /// Required. Full resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. + /// If the caller does not have permission to access the TargetSite, regardless of + /// whether or not it exists, a PERMISSION_DENIED error is returned. If the requested + /// TargetSite does not exist, a NOT_FOUND error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the method name. - public override string MethodName => "fetchDomainVerificationStatus"; + /// Gets the method name. + public override string MethodName => "delete"; - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Gets the HTTP method. + public override string HttpMethod => "DELETE"; - /// Gets the REST path. - public override string RestPath => "v1/{+siteSearchEngine}:fetchDomainVerificationStatus"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Initializes FetchDomainVerificationStatus parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter - { - Name = "siteSearchEngine", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", - }); - RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter - { - Name = "pageSize", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + /// Initializes Delete parameter list. + protected override void InitParameters() { - Name = "pageToken", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", + }); + } } - } - - /// Request on-demand recrawl for a list of URIs. - /// The body of the request. - /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. - /// - public virtual RecrawlUrisRequest RecrawlUris(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest body, string siteSearchEngine) - { - return new RecrawlUrisRequest(this.service, body, siteSearchEngine); - } - /// Request on-demand recrawl for a list of URIs. - public class RecrawlUrisRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new RecrawlUris request. - public RecrawlUrisRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest body, string siteSearchEngine) : base(service) + /// Gets a TargetSite. + /// + /// Required. Full resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. + /// If the caller does not have permission to access the TargetSite, regardless of whether + /// or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite + /// does not exist, a NOT_FOUND error is returned. + /// + public virtual GetRequest Get(string name) { - SiteSearchEngine = siteSearchEngine; - Body = body; - InitParameters(); + return new GetRequest(this.service, name); } - /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. - /// - [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] - public virtual string SiteSearchEngine { get; private set; } - - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest Body { get; set; } + /// Gets a TargetSite. + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// + /// Required. Full resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. + /// If the caller does not have permission to access the TargetSite, regardless of + /// whether or not it exists, a PERMISSION_DENIED error is returned. If the requested + /// TargetSite does not exist, a NOT_FOUND error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the method name. - public override string MethodName => "recrawlUris"; + /// Gets the method name. + public override string MethodName => "get"; - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Gets the REST path. - public override string RestPath => "v1/{+siteSearchEngine}:recrawlUris"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Initializes RecrawlUris parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter + /// Initializes Get parameter list. + protected override void InitParameters() { - Name = "siteSearchEngine", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", - }); + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", + }); + } } - } - } - - /// Gets the SuggestionDenyListEntries resource. - public virtual SuggestionDenyListEntriesResource SuggestionDenyListEntries { get; } - /// The "suggestionDenyListEntries" collection of methods. - public class SuggestionDenyListEntriesResource - { - private const string Resource = "suggestionDenyListEntries"; + /// Gets a list of TargetSites. + /// + /// Required. The parent site search engine resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// If the caller does not have permission to list TargetSites under this site search + /// engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is + /// returned. + /// + public virtual ListRequest List(string parent) + { + return new ListRequest(this.service, parent); + } - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + /// Gets a list of TargetSites. + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + { + Parent = parent; + InitParameters(); + } - /// Constructs a new resource. - public SuggestionDenyListEntriesResource(Google.Apis.Services.IClientService service) - { - this.service = service; + /// + /// Required. The parent site search engine resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// If the caller does not have permission to list TargetSites under this site search + /// engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error + /// is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// + /// Requested page size. Server may return fewer items than requested. If unspecified, + /// server will pick an appropriate default. The maximum value is 1000; values above + /// 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error + /// is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } + + /// + /// A page token, received from a previous `ListTargetSites` call. Provide this to + /// retrieve the subsequent page. When paginating, all other parameters provided to + /// `ListTargetSites` must match the call that provided the page token. + /// + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } + + /// Gets the method name. + public override string MethodName => "list"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/targetSites"; + + /// Initializes List parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + + /// Updates a TargetSite. + /// The body of the request. + /// + /// Output only. The fully qualified resource name of the target site. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` + /// The `target_site_id` is system-generated. + /// + public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string name) + { + return new PatchRequest(this.service, body, name); + } + + /// Updates a TargetSite. + public class PatchRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Patch request. + public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string name) : base(service) + { + Name = name; + Body = body; + InitParameters(); + } + + /// + /// Output only. The fully qualified resource name of the target site. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` + /// The `target_site_id` is system-generated. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "patch"; + + /// Gets the HTTP method. + public override string HttpMethod => "PATCH"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Patch parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", + }); + } + } } - /// Imports all SuggestionDenyListEntry for a DataStore. + /// + /// Verify target sites' ownership and validity. This API sends all the target sites under site + /// search engine for verification. + /// /// The body of the request. /// - /// Required. The parent data store resource name for which to import denylist entries. Follows - /// pattern projects/*/locations/*/collections/*/dataStores/*. + /// Required. The parent resource shared by all TargetSites being verified. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. /// - public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest body, string parent) + public virtual BatchVerifyTargetSitesRequest BatchVerifyTargetSites(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest body, string parent) { - return new ImportRequest(this.service, body, parent); + return new BatchVerifyTargetSitesRequest(this.service, body, parent); } - /// Imports all SuggestionDenyListEntry for a DataStore. - public class ImportRequest : DiscoveryEngineBaseServiceRequest + /// + /// Verify target sites' ownership and validity. This API sends all the target sites under site + /// search engine for verification. + /// + public class BatchVerifyTargetSitesRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Import request. - public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest body, string parent) : base(service) + /// Constructs a new BatchVerifyTargetSites request. + public BatchVerifyTargetSitesRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest body, string parent) : base(service) { Parent = parent; Body = body; @@ -3864,28 +4038,28 @@ public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.Di } /// - /// Required. The parent data store resource name for which to import denylist entries. - /// Follows pattern projects/*/locations/*/collections/*/dataStores/*. + /// Required. The parent resource shared by all TargetSites being verified. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. /// [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] public virtual string Parent { get; private set; } /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest Body { get; set; } + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest Body { get; set; } /// Returns the body of the request. protected override object GetBody() => Body; /// Gets the method name. - public override string MethodName => "import"; + public override string MethodName => "batchVerifyTargetSites"; /// Gets the HTTP method. public override string HttpMethod => "POST"; /// Gets the REST path. - public override string RestPath => "v1/{+parent}/suggestionDenyListEntries:import"; + public override string RestPath => "v1/{+parent}:batchVerifyTargetSites"; - /// Initializes Import parameter list. + /// Initializes BatchVerifyTargetSites parameter list. protected override void InitParameters() { base.InitParameters(); @@ -3895,186 +4069,213 @@ protected override void InitParameters() IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", }); } } - /// Permanently deletes all SuggestionDenyListEntry for a DataStore. + /// Downgrade from advanced site search to basic site search. /// The body of the request. - /// - /// Required. The parent data store resource name for which to import denylist entries. Follows - /// pattern projects/*/locations/*/collections/*/dataStores/*. + /// + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. /// - public virtual PurgeRequest Purge(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest body, string parent) + public virtual DisableAdvancedSiteSearchRequest DisableAdvancedSiteSearch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest body, string siteSearchEngine) { - return new PurgeRequest(this.service, body, parent); + return new DisableAdvancedSiteSearchRequest(this.service, body, siteSearchEngine); } - /// Permanently deletes all SuggestionDenyListEntry for a DataStore. - public class PurgeRequest : DiscoveryEngineBaseServiceRequest + /// Downgrade from advanced site search to basic site search. + public class DisableAdvancedSiteSearchRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Purge request. - public PurgeRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest body, string parent) : base(service) + /// Constructs a new DisableAdvancedSiteSearch request. + public DisableAdvancedSiteSearchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest body, string siteSearchEngine) : base(service) { - Parent = parent; + SiteSearchEngine = siteSearchEngine; Body = body; InitParameters(); } /// - /// Required. The parent data store resource name for which to import denylist entries. - /// Follows pattern projects/*/locations/*/collections/*/dataStores/*. + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] + public virtual string SiteSearchEngine { get; private set; } /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest Body { get; set; } + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest Body { get; set; } /// Returns the body of the request. protected override object GetBody() => Body; /// Gets the method name. - public override string MethodName => "purge"; + public override string MethodName => "disableAdvancedSiteSearch"; /// Gets the HTTP method. public override string HttpMethod => "POST"; /// Gets the REST path. - public override string RestPath => "v1/{+parent}/suggestionDenyListEntries:purge"; + public override string RestPath => "v1/{+siteSearchEngine}:disableAdvancedSiteSearch"; - /// Initializes Purge parameter list. + /// Initializes DisableAdvancedSiteSearch parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter { - Name = "parent", + Name = "siteSearchEngine", IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", }); } } - } - /// Gets the UserEvents resource. - public virtual UserEventsResource UserEvents { get; } + /// Upgrade from basic site search to advanced site search. + /// The body of the request. + /// + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. + /// + public virtual EnableAdvancedSiteSearchRequest EnableAdvancedSiteSearch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest body, string siteSearchEngine) + { + return new EnableAdvancedSiteSearchRequest(this.service, body, siteSearchEngine); + } - /// The "userEvents" collection of methods. - public class UserEventsResource - { - private const string Resource = "userEvents"; + /// Upgrade from basic site search to advanced site search. + public class EnableAdvancedSiteSearchRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new EnableAdvancedSiteSearch request. + public EnableAdvancedSiteSearchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest body, string siteSearchEngine) : base(service) + { + SiteSearchEngine = siteSearchEngine; + Body = body; + InitParameters(); + } - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + /// + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. + /// + [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] + public virtual string SiteSearchEngine { get; private set; } - /// Constructs a new resource. - public UserEventsResource(Google.Apis.Services.IClientService service) - { - this.service = service; + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "enableAdvancedSiteSearch"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+siteSearchEngine}:enableAdvancedSiteSearch"; + + /// Initializes EnableAdvancedSiteSearch parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter + { + Name = "siteSearchEngine", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", + }); + } } /// - /// Writes a single user event from the browser. This uses a GET request to due to browser - /// restriction of POST-ing to a third-party domain. This method is used only by the Discovery - /// Engine API JavaScript pixel and Google Tag Manager. Users should not call this method - /// directly. + /// Returns list of target sites with its domain verification status. This method can only be + /// called under data store with BASIC_SITE_SEARCH state at the moment. /// - /// - /// Required. The parent DataStore resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. + /// + /// Required. The site search engine resource under which we fetch all the domain verification + /// status. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. /// - public virtual CollectRequest Collect(string parent) + public virtual FetchDomainVerificationStatusRequest FetchDomainVerificationStatus(string siteSearchEngine) { - return new CollectRequest(this.service, parent); + return new FetchDomainVerificationStatusRequest(this.service, siteSearchEngine); } /// - /// Writes a single user event from the browser. This uses a GET request to due to browser - /// restriction of POST-ing to a third-party domain. This method is used only by the Discovery - /// Engine API JavaScript pixel and Google Tag Manager. Users should not call this method - /// directly. + /// Returns list of target sites with its domain verification status. This method can only be + /// called under data store with BASIC_SITE_SEARCH state at the moment. /// - public class CollectRequest : DiscoveryEngineBaseServiceRequest + public class FetchDomainVerificationStatusRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Collect request. - public CollectRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + /// Constructs a new FetchDomainVerificationStatus request. + public FetchDomainVerificationStatusRequest(Google.Apis.Services.IClientService service, string siteSearchEngine) : base(service) { - Parent = parent; + SiteSearchEngine = siteSearchEngine; InitParameters(); } /// - /// Required. The parent DataStore resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } - - /// - /// The event timestamp in milliseconds. This prevents browser caching of otherwise - /// identical get requests. The name is abbreviated to reduce the payload bytes. + /// Required. The site search engine resource under which we fetch all the domain + /// verification status. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. /// - [Google.Apis.Util.RequestParameterAttribute("ets", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable Ets { get; set; } + [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] + public virtual string SiteSearchEngine { get; private set; } /// - /// The URL including cgi-parameters but excluding the hash fragment with a length limit of - /// 5,000 characters. This is often more useful than the referer URL, because many browsers - /// only send the domain for third-party requests. + /// Requested page size. Server may return fewer items than requested. If unspecified, + /// server will pick an appropriate default. The maximum value is 1000; values above 1000 + /// will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is + /// returned. /// - [Google.Apis.Util.RequestParameterAttribute("uri", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Uri { get; set; } + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } /// - /// Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + /// A page token, received from a previous `FetchDomainVerificationStatus` call. Provide + /// this to retrieve the subsequent page. When paginating, all other parameters provided to + /// `FetchDomainVerificationStatus` must match the call that provided the page token. /// - [Google.Apis.Util.RequestParameterAttribute("userEvent", Google.Apis.Util.RequestParameterType.Query)] - public virtual string UserEvent { get; set; } + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } /// Gets the method name. - public override string MethodName => "collect"; + public override string MethodName => "fetchDomainVerificationStatus"; /// Gets the HTTP method. public override string HttpMethod => "GET"; /// Gets the REST path. - public override string RestPath => "v1/{+parent}/userEvents:collect"; + public override string RestPath => "v1/{+siteSearchEngine}:fetchDomainVerificationStatus"; - /// Initializes Collect parameter list. + /// Initializes FetchDomainVerificationStatus parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter { - Name = "parent", + Name = "siteSearchEngine", IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", - }); - RequestParameters.Add("ets", new Google.Apis.Discovery.Parameter - { - Name = "ets", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", }); - RequestParameters.Add("uri", new Google.Apis.Discovery.Parameter + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter { - Name = "uri", + Name = "pageSize", IsRequired = false, ParameterType = "query", DefaultValue = null, Pattern = null, }); - RequestParameters.Add("userEvent", new Google.Apis.Discovery.Parameter + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter { - Name = "userEvent", + Name = "pageToken", IsRequired = false, ParameterType = "query", DefaultValue = null, @@ -4083,95 +4284,99 @@ protected override void InitParameters() } } - /// - /// Bulk import of User events. Request processing might be synchronous. Events that already - /// exist are skipped. Use this method for backfilling historical user events. - /// Operation.response is of type ImportResponse. Note that it is possible for a subset of the - /// items to be successfully inserted. Operation.metadata is of type ImportMetadata. - /// + /// Request on-demand recrawl for a list of URIs. /// The body of the request. - /// - /// Required. Parent DataStore resource name, of the form - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` + /// + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. /// - public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest body, string parent) + public virtual RecrawlUrisRequest RecrawlUris(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest body, string siteSearchEngine) { - return new ImportRequest(this.service, body, parent); + return new RecrawlUrisRequest(this.service, body, siteSearchEngine); } - /// - /// Bulk import of User events. Request processing might be synchronous. Events that already - /// exist are skipped. Use this method for backfilling historical user events. - /// Operation.response is of type ImportResponse. Note that it is possible for a subset of the - /// items to be successfully inserted. Operation.metadata is of type ImportMetadata. - /// - public class ImportRequest : DiscoveryEngineBaseServiceRequest + /// Request on-demand recrawl for a list of URIs. + public class RecrawlUrisRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Import request. - public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest body, string parent) : base(service) + /// Constructs a new RecrawlUris request. + public RecrawlUrisRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest body, string siteSearchEngine) : base(service) { - Parent = parent; + SiteSearchEngine = siteSearchEngine; Body = body; InitParameters(); } /// - /// Required. Parent DataStore resource name, of the form - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] + public virtual string SiteSearchEngine { get; private set; } /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest Body { get; set; } + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest Body { get; set; } /// Returns the body of the request. protected override object GetBody() => Body; /// Gets the method name. - public override string MethodName => "import"; + public override string MethodName => "recrawlUris"; /// Gets the HTTP method. public override string HttpMethod => "POST"; /// Gets the REST path. - public override string RestPath => "v1/{+parent}/userEvents:import"; + public override string RestPath => "v1/{+siteSearchEngine}:recrawlUris"; - /// Initializes Import parameter list. + /// Initializes RecrawlUris parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter { - Name = "parent", + Name = "siteSearchEngine", IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", }); } } + } - /// Writes a single user event. + /// Gets the SuggestionDenyListEntries resource. + public virtual SuggestionDenyListEntriesResource SuggestionDenyListEntries { get; } + + /// The "suggestionDenyListEntries" collection of methods. + public class SuggestionDenyListEntriesResource + { + private const string Resource = "suggestionDenyListEntries"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public SuggestionDenyListEntriesResource(Google.Apis.Services.IClientService service) + { + this.service = service; + } + + /// Imports all SuggestionDenyListEntry for a DataStore. /// The body of the request. /// - /// Required. The parent resource name. If the write user event action is applied in DataStore - /// level, the format is: - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. - /// If the write user event action is applied in Location level, for example, the event with - /// Document across multiple DataStore, the format is: - /// `projects/{project}/locations/{location}`. + /// Required. The parent data store resource name for which to import denylist entries. Follows + /// pattern projects/*/locations/*/collections/*/dataStores/*. /// - public virtual WriteRequest Write(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) + public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest body, string parent) { - return new WriteRequest(this.service, body, parent); + return new ImportRequest(this.service, body, parent); } - /// Writes a single user event. - public class WriteRequest : DiscoveryEngineBaseServiceRequest + /// Imports all SuggestionDenyListEntry for a DataStore. + public class ImportRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Write request. - public WriteRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) : base(service) + /// Constructs a new Import request. + public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest body, string parent) : base(service) { Parent = parent; Body = body; @@ -4179,32 +4384,28 @@ public WriteRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis } /// - /// Required. The parent resource name. If the write user event action is applied in - /// DataStore level, the format is: - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. - /// If the write user event action is applied in Location level, for example, the event with - /// Document across multiple DataStore, the format is: - /// `projects/{project}/locations/{location}`. + /// Required. The parent data store resource name for which to import denylist entries. + /// Follows pattern projects/*/locations/*/collections/*/dataStores/*. /// [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] public virtual string Parent { get; private set; } /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent Body { get; set; } + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest Body { get; set; } /// Returns the body of the request. protected override object GetBody() => Body; /// Gets the method name. - public override string MethodName => "write"; + public override string MethodName => "import"; /// Gets the HTTP method. public override string HttpMethod => "POST"; /// Gets the REST path. - public override string RestPath => "v1/{+parent}/userEvents:write"; + public override string RestPath => "v1/{+parent}/suggestionDenyListEntries:import"; - /// Initializes Write parameter list. + /// Initializes Import parameter list. protected override void InitParameters() { base.InitParameters(); @@ -4218,462 +4419,518 @@ protected override void InitParameters() }); } } - } - /// Completes the specified user input with keyword suggestions. - /// - /// Required. The parent data store resource name for which the completion is performed, such as - /// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. - /// - public virtual CompleteQueryRequest CompleteQuery(string dataStore) - { - return new CompleteQueryRequest(this.service, dataStore); - } - - /// Completes the specified user input with keyword suggestions. - public class CompleteQueryRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new CompleteQuery request. - public CompleteQueryRequest(Google.Apis.Services.IClientService service, string dataStore) : base(service) + /// Permanently deletes all SuggestionDenyListEntry for a DataStore. + /// The body of the request. + /// + /// Required. The parent data store resource name for which to import denylist entries. Follows + /// pattern projects/*/locations/*/collections/*/dataStores/*. + /// + public virtual PurgeRequest Purge(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest body, string parent) { - DataStore = dataStore; - InitParameters(); + return new PurgeRequest(this.service, body, parent); } - /// - /// Required. The parent data store resource name for which the completion is performed, such as - /// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. - /// - [Google.Apis.Util.RequestParameterAttribute("dataStore", Google.Apis.Util.RequestParameterType.Path)] - public virtual string DataStore { get; private set; } - - /// - /// Indicates if tail suggestions should be returned if there are no suggestions that match the - /// full query. Even if set to true, if there are suggestions that match the full query, those - /// are returned and no tail suggestions are returned. - /// - [Google.Apis.Util.RequestParameterAttribute("includeTailSuggestions", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable IncludeTailSuggestions { get; set; } + /// Permanently deletes all SuggestionDenyListEntry for a DataStore. + public class PurgeRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Purge request. + public PurgeRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } - /// - /// Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - /// - [Google.Apis.Util.RequestParameterAttribute("query", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Query { get; set; } + /// + /// Required. The parent data store resource name for which to import denylist entries. + /// Follows pattern projects/*/locations/*/collections/*/dataStores/*. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// - /// Specifies the autocomplete data model. This overrides any model specified in the - /// Configuration > Autocomplete section of the Cloud console. Currently supported - /// values: * `document` - Using suggestions generated from user-imported documents. * - /// `search-history` - Using suggestions generated from the past history of SearchService.Search - /// API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using - /// suggestions generated from user-imported search events. * `document-completable` - Using - /// suggestions taken directly from user-imported document fields marked as completable. Default - /// values: * `document` is the default model for regular dataStores. * `search-history` is the - /// default model for site search dataStores. - /// - [Google.Apis.Util.RequestParameterAttribute("queryModel", Google.Apis.Util.RequestParameterType.Query)] - public virtual string QueryModel { get; set; } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest Body { get; set; } - /// - /// A unique identifier for tracking visitors. For example, this could be implemented with an - /// HTTP cookie, which should be able to uniquely identify a visitor on a single device. This - /// unique identifier should not change if the visitor logs in or out of the website. This field - /// should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier - /// as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 - /// encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error - /// is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("userPseudoId", Google.Apis.Util.RequestParameterType.Query)] - public virtual string UserPseudoId { get; set; } + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the method name. - public override string MethodName => "completeQuery"; + /// Gets the method name. + public override string MethodName => "purge"; - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Gets the HTTP method. + public override string HttpMethod => "POST"; - /// Gets the REST path. - public override string RestPath => "v1/{+dataStore}:completeQuery"; + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/suggestionDenyListEntries:purge"; - /// Initializes CompleteQuery parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("dataStore", new Google.Apis.Discovery.Parameter - { - Name = "dataStore", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", - }); - RequestParameters.Add("includeTailSuggestions", new Google.Apis.Discovery.Parameter - { - Name = "includeTailSuggestions", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("query", new Google.Apis.Discovery.Parameter - { - Name = "query", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("queryModel", new Google.Apis.Discovery.Parameter - { - Name = "queryModel", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("userPseudoId", new Google.Apis.Discovery.Parameter + /// Initializes Purge parameter list. + protected override void InitParameters() { - Name = "userPseudoId", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + }); + } } } - /// - /// Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or - /// Recommendation use case, an Engine needs to be created separately. - /// - /// The body of the request. - /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}`. - /// - public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string parent) - { - return new CreateRequest(this.service, body, parent); - } + /// Gets the UserEvents resource. + public virtual UserEventsResource UserEvents { get; } - /// - /// Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or - /// Recommendation use case, an Engine needs to be created separately. - /// - public class CreateRequest : DiscoveryEngineBaseServiceRequest + /// The "userEvents" collection of methods. + public class UserEventsResource { - /// Constructs a new Create request. - public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string parent) : base(service) + private const string Resource = "userEvents"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public UserEventsResource(Google.Apis.Services.IClientService service) { - Parent = parent; - Body = body; - InitParameters(); + this.service = service; } /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}`. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } - - /// - /// A boolean flag indicating whether user want to directly create an advanced data store for - /// site search. If the data store is not configured as site search (GENERIC vertical and - /// PUBLIC_WEBSITE content_config), this flag will be ignored. + /// Writes a single user event from the browser. This uses a GET request to due to browser + /// restriction of POST-ing to a third-party domain. This method is used only by the Discovery + /// Engine API JavaScript pixel and Google Tag Manager. Users should not call this method + /// directly. /// - [Google.Apis.Util.RequestParameterAttribute("createAdvancedSiteSearch", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable CreateAdvancedSiteSearch { get; set; } + /// + /// Required. The parent DataStore resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. + /// + public virtual CollectRequest Collect(string parent) + { + return new CollectRequest(this.service, parent); + } /// - /// Required. The ID to use for the DataStore, which will become the final component of the - /// DataStore's resource name. This field must conform to - /// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 - /// characters. Otherwise, an INVALID_ARGUMENT error is returned. + /// Writes a single user event from the browser. This uses a GET request to due to browser + /// restriction of POST-ing to a third-party domain. This method is used only by the Discovery + /// Engine API JavaScript pixel and Google Tag Manager. Users should not call this method + /// directly. /// - [Google.Apis.Util.RequestParameterAttribute("dataStoreId", Google.Apis.Util.RequestParameterType.Query)] - public virtual string DataStoreId { get; set; } + public class CollectRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Collect request. + public CollectRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + { + Parent = parent; + InitParameters(); + } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore Body { get; set; } + /// + /// Required. The parent DataStore resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// + /// The event timestamp in milliseconds. This prevents browser caching of otherwise + /// identical get requests. The name is abbreviated to reduce the payload bytes. + /// + [Google.Apis.Util.RequestParameterAttribute("ets", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable Ets { get; set; } - /// Gets the method name. - public override string MethodName => "create"; + /// + /// The URL including cgi-parameters but excluding the hash fragment with a length limit of + /// 5,000 characters. This is often more useful than the referer URL, because many browsers + /// only send the domain for third-party requests. + /// + [Google.Apis.Util.RequestParameterAttribute("uri", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Uri { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// + /// Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + /// + [Google.Apis.Util.RequestParameterAttribute("userEvent", Google.Apis.Util.RequestParameterType.Query)] + public virtual string UserEvent { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/dataStores"; + /// Gets the method name. + public override string MethodName => "collect"; - /// Initializes Create parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+$", - }); - RequestParameters.Add("createAdvancedSiteSearch", new Google.Apis.Discovery.Parameter - { - Name = "createAdvancedSiteSearch", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("dataStoreId", new Google.Apis.Discovery.Parameter + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/userEvents:collect"; + + /// Initializes Collect parameter list. + protected override void InitParameters() { - Name = "dataStoreId", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + }); + RequestParameters.Add("ets", new Google.Apis.Discovery.Parameter + { + Name = "ets", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("uri", new Google.Apis.Discovery.Parameter + { + Name = "uri", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("userEvent", new Google.Apis.Discovery.Parameter + { + Name = "userEvent", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } } - } - /// Deletes a DataStore. - /// - /// Required. Full resource name of DataStore, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - /// If the caller does not have permission to delete the DataStore, regardless of whether or not it - /// exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a - /// NOT_FOUND error is returned. - /// - public virtual DeleteRequest Delete(string name) - { - return new DeleteRequest(this.service, name); - } - - /// Deletes a DataStore. - public class DeleteRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Delete request. - public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) + /// + /// Bulk import of user events. Request processing might be synchronous. Events that already + /// exist are skipped. Use this method for backfilling historical user events. + /// Operation.response is of type ImportResponse. Note that it is possible for a subset of the + /// items to be successfully inserted. Operation.metadata is of type ImportMetadata. + /// + /// The body of the request. + /// + /// Required. Parent DataStore resource name, of the form + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` + /// + public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest body, string parent) { - Name = name; - InitParameters(); + return new ImportRequest(this.service, body, parent); } /// - /// Required. Full resource name of DataStore, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - /// If the caller does not have permission to delete the DataStore, regardless of whether or not - /// it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, - /// a NOT_FOUND error is returned. + /// Bulk import of user events. Request processing might be synchronous. Events that already + /// exist are skipped. Use this method for backfilling historical user events. + /// Operation.response is of type ImportResponse. Note that it is possible for a subset of the + /// items to be successfully inserted. Operation.metadata is of type ImportMetadata. /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + public class ImportRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Import request. + public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } - /// Gets the method name. - public override string MethodName => "delete"; + /// + /// Required. Parent DataStore resource name, of the form + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Gets the HTTP method. - public override string HttpMethod => "DELETE"; + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest Body { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Initializes Delete parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + /// Gets the method name. + public override string MethodName => "import"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/userEvents:import"; + + /// Initializes Import parameter list. + protected override void InitParameters() { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", - }); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + }); + } } - } - - /// Gets a DataStore. - /// - /// Required. Full resource name of DataStore, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - /// If the caller does not have permission to access the DataStore, regardless of whether or not it - /// exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a - /// NOT_FOUND error is returned. - /// - public virtual GetRequest Get(string name) - { - return new GetRequest(this.service, name); - } - /// Gets a DataStore. - public class GetRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + /// Writes a single user event. + /// The body of the request. + /// + /// Required. The parent resource name. If the write user event action is applied in DataStore + /// level, the format is: + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. + /// If the write user event action is applied in Location level, for example, the event with + /// Document across multiple DataStore, the format is: + /// `projects/{project}/locations/{location}`. + /// + public virtual WriteRequest Write(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) { - Name = name; - InitParameters(); + return new WriteRequest(this.service, body, parent); } - /// - /// Required. Full resource name of DataStore, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - /// If the caller does not have permission to access the DataStore, regardless of whether or not - /// it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, - /// a NOT_FOUND error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// Writes a single user event. + public class WriteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Write request. + public WriteRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } - /// Gets the method name. - public override string MethodName => "get"; + /// + /// Required. The parent resource name. If the write user event action is applied in + /// DataStore level, the format is: + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. + /// If the write user event action is applied in Location level, for example, the event with + /// Document across multiple DataStore, the format is: + /// `projects/{project}/locations/{location}`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent Body { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Initializes Get parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + /// Gets the method name. + public override string MethodName => "write"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/userEvents:write"; + + /// Initializes Write parameter list. + protected override void InitParameters() { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", - }); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + }); + } } } - /// Gets the SiteSearchEngine. - /// - /// Required. Resource name of SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// If the caller does not have permission to access the [SiteSearchEngine], regardless of whether - /// or not it exists, a PERMISSION_DENIED error is returned. + /// Completes the specified user input with keyword suggestions. + /// + /// Required. The parent data store resource name for which the completion is performed, such as + /// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. /// - public virtual GetSiteSearchEngineRequest GetSiteSearchEngine(string name) + public virtual CompleteQueryRequest CompleteQuery(string dataStore) { - return new GetSiteSearchEngineRequest(this.service, name); + return new CompleteQueryRequest(this.service, dataStore); } - /// Gets the SiteSearchEngine. - public class GetSiteSearchEngineRequest : DiscoveryEngineBaseServiceRequest + /// Completes the specified user input with keyword suggestions. + public class CompleteQueryRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new GetSiteSearchEngine request. - public GetSiteSearchEngineRequest(Google.Apis.Services.IClientService service, string name) : base(service) + /// Constructs a new CompleteQuery request. + public CompleteQueryRequest(Google.Apis.Services.IClientService service, string dataStore) : base(service) { - Name = name; + DataStore = dataStore; InitParameters(); } /// - /// Required. Resource name of SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// If the caller does not have permission to access the [SiteSearchEngine], regardless of - /// whether or not it exists, a PERMISSION_DENIED error is returned. + /// Required. The parent data store resource name for which the completion is performed, such as + /// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + [Google.Apis.Util.RequestParameterAttribute("dataStore", Google.Apis.Util.RequestParameterType.Path)] + public virtual string DataStore { get; private set; } + + /// + /// Indicates if tail suggestions should be returned if there are no suggestions that match the + /// full query. Even if set to true, if there are suggestions that match the full query, those + /// are returned and no tail suggestions are returned. + /// + [Google.Apis.Util.RequestParameterAttribute("includeTailSuggestions", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable IncludeTailSuggestions { get; set; } + + /// + /// Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + /// + [Google.Apis.Util.RequestParameterAttribute("query", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Query { get; set; } + + /// + /// Specifies the autocomplete data model. This overrides any model specified in the + /// Configuration > Autocomplete section of the Cloud console. Currently supported + /// values: * `document` - Using suggestions generated from user-imported documents. * + /// `search-history` - Using suggestions generated from the past history of SearchService.Search + /// API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using + /// suggestions generated from user-imported search events. * `document-completable` - Using + /// suggestions taken directly from user-imported document fields marked as completable. Default + /// values: * `document` is the default model for regular dataStores. * `search-history` is the + /// default model for site search dataStores. + /// + [Google.Apis.Util.RequestParameterAttribute("queryModel", Google.Apis.Util.RequestParameterType.Query)] + public virtual string QueryModel { get; set; } + + /// + /// A unique identifier for tracking visitors. For example, this could be implemented with an + /// HTTP cookie, which should be able to uniquely identify a visitor on a single device. This + /// unique identifier should not change if the visitor logs in or out of the website. This field + /// should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier + /// as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 + /// encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error + /// is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("userPseudoId", Google.Apis.Util.RequestParameterType.Query)] + public virtual string UserPseudoId { get; set; } /// Gets the method name. - public override string MethodName => "getSiteSearchEngine"; + public override string MethodName => "completeQuery"; /// Gets the HTTP method. public override string HttpMethod => "GET"; /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + public override string RestPath => "v1/{+dataStore}:completeQuery"; - /// Initializes GetSiteSearchEngine parameter list. + /// Initializes CompleteQuery parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + RequestParameters.Add("dataStore", new Google.Apis.Discovery.Parameter { - Name = "name", + Name = "dataStore", IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + }); + RequestParameters.Add("includeTailSuggestions", new Google.Apis.Discovery.Parameter + { + Name = "includeTailSuggestions", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("query", new Google.Apis.Discovery.Parameter + { + Name = "query", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("queryModel", new Google.Apis.Discovery.Parameter + { + Name = "queryModel", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("userPseudoId", new Google.Apis.Discovery.Parameter + { + Name = "userPseudoId", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, }); } } - /// Lists all the DataStores associated with the project. + /// + /// Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or + /// Recommendation use case, an Engine needs to be created separately. + /// + /// The body of the request. /// - /// Required. The parent branch resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not - /// have permission to list DataStores under this location, regardless of whether or not this data - /// store exists, a PERMISSION_DENIED error is returned. + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}`. /// - public virtual ListRequest List(string parent) + public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string parent) { - return new ListRequest(this.service, parent); + return new CreateRequest(this.service, body, parent); } - /// Lists all the DataStores associated with the project. - public class ListRequest : DiscoveryEngineBaseServiceRequest + /// + /// Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or + /// Recommendation use case, an Engine needs to be created separately. + /// + public class CreateRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + /// Constructs a new Create request. + public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string parent) : base(service) { Parent = parent; + Body = body; InitParameters(); } /// - /// Required. The parent branch resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does - /// not have permission to list DataStores under this location, regardless of whether or not - /// this data store exists, a PERMISSION_DENIED error is returned. + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}`. /// [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] public virtual string Parent { get; private set; } /// - /// Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' + /// A boolean flag indicating whether user want to directly create an advanced data store for + /// site search. If the data store is not configured as site search (GENERIC vertical and + /// PUBLIC_WEBSITE content_config), this flag will be ignored. /// - [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Filter { get; set; } + [Google.Apis.Util.RequestParameterAttribute("createAdvancedSiteSearch", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable CreateAdvancedSiteSearch { get; set; } /// - /// Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed - /// value is 50. Values above 50 will be coerced to 50. If this field is negative, an - /// INVALID_ARGUMENT is returned. + /// Required. The ID to use for the DataStore, which will become the final component of the + /// DataStore's resource name. This field must conform to + /// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 + /// characters. Otherwise, an INVALID_ARGUMENT error is returned. /// - [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable PageSize { get; set; } + [Google.Apis.Util.RequestParameterAttribute("dataStoreId", Google.Apis.Util.RequestParameterType.Query)] + public virtual string DataStoreId { get; set; } - /// - /// A page token ListDataStoresResponse.next_page_token, received from a previous - /// DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When - /// paginating, all other parameters provided to DataStoreService.ListDataStores must match the - /// call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] - public virtual string PageToken { get; set; } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; /// Gets the method name. - public override string MethodName => "list"; + public override string MethodName => "create"; /// Gets the HTTP method. - public override string HttpMethod => "GET"; + public override string HttpMethod => "POST"; /// Gets the REST path. public override string RestPath => "v1/{+parent}/dataStores"; - /// Initializes List parameter list. + /// Initializes Create parameter list. protected override void InitParameters() { base.InitParameters(); @@ -4685,25 +4942,17 @@ protected override void InitParameters() DefaultValue = null, Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+$", }); - RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter - { - Name = "filter", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + RequestParameters.Add("createAdvancedSiteSearch", new Google.Apis.Discovery.Parameter { - Name = "pageSize", + Name = "createAdvancedSiteSearch", IsRequired = false, ParameterType = "query", DefaultValue = null, Pattern = null, }); - RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + RequestParameters.Add("dataStoreId", new Google.Apis.Discovery.Parameter { - Name = "pageToken", + Name = "dataStoreId", IsRequired = false, ParameterType = "query", DefaultValue = null, @@ -4712,60 +4961,49 @@ protected override void InitParameters() } } - /// Updates a DataStore - /// The body of the request. + /// Deletes a DataStore. /// - /// Immutable. The full resource name of the data store. Format: + /// Required. Full resource name of DataStore, such as /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - /// This field must be a UTF-8 encoded string with a length limit of 1024 characters. + /// If the caller does not have permission to delete the DataStore, regardless of whether or not it + /// exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a + /// NOT_FOUND error is returned. /// - public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string name) + public virtual DeleteRequest Delete(string name) { - return new PatchRequest(this.service, body, name); + return new DeleteRequest(this.service, name); } - /// Updates a DataStore - public class PatchRequest : DiscoveryEngineBaseServiceRequest + /// Deletes a DataStore. + public class DeleteRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Patch request. - public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string name) : base(service) + /// Constructs a new Delete request. + public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) { Name = name; - Body = body; InitParameters(); } /// - /// Immutable. The full resource name of the data store. Format: + /// Required. Full resource name of DataStore, such as /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - /// This field must be a UTF-8 encoded string with a length limit of 1024 characters. + /// If the caller does not have permission to delete the DataStore, regardless of whether or not + /// it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, + /// a NOT_FOUND error is returned. /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] public virtual string Name { get; private set; } - /// - /// Indicates which fields in the provided DataStore to update. If an unsupported or unknown - /// field is provided, an INVALID_ARGUMENT error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] - public virtual object UpdateMask { get; set; } - - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore Body { get; set; } - - /// Returns the body of the request. - protected override object GetBody() => Body; - /// Gets the method name. - public override string MethodName => "patch"; + public override string MethodName => "delete"; /// Gets the HTTP method. - public override string HttpMethod => "PATCH"; + public override string HttpMethod => "DELETE"; /// Gets the REST path. public override string RestPath => "v1/{+name}"; - /// Initializes Patch parameter list. + /// Initializes Delete parameter list. protected override void InitParameters() { base.InitParameters(); @@ -4777,230 +5015,391 @@ protected override void InitParameters() DefaultValue = null, Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", }); - RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter - { - Name = "updateMask", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); } } - } - - /// Gets the Engines resource. - public virtual EnginesResource Engines { get; } - - /// The "engines" collection of methods. - public class EnginesResource - { - private const string Resource = "engines"; - - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; - /// Constructs a new resource. - public EnginesResource(Google.Apis.Services.IClientService service) + /// Gets a DataStore. + /// + /// Required. Full resource name of DataStore, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + /// If the caller does not have permission to access the DataStore, regardless of whether or not it + /// exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a + /// NOT_FOUND error is returned. + /// + public virtual GetRequest Get(string name) { - this.service = service; - Conversations = new ConversationsResource(service); - Operations = new OperationsResource(service); - ServingConfigs = new ServingConfigsResource(service); + return new GetRequest(this.service, name); } - /// Gets the Conversations resource. - public virtual ConversationsResource Conversations { get; } - - /// The "conversations" collection of methods. - public class ConversationsResource + /// Gets a DataStore. + public class GetRequest : DiscoveryEngineBaseServiceRequest { - private const string Resource = "conversations"; - - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; - - /// Constructs a new resource. - public ConversationsResource(Google.Apis.Services.IClientService service) + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) { - this.service = service; + Name = name; + InitParameters(); } - /// Converses a conversation. - /// The body of the request. - /// - /// Required. The resource name of the Conversation to get. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. - /// Use - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` - /// to activate auto session mode, which automatically creates a new conversation inside a - /// ConverseConversation session. - /// - public virtual ConverseRequest Converse(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest body, string name) - { - return new ConverseRequest(this.service, body, name); - } + /// + /// Required. Full resource name of DataStore, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + /// If the caller does not have permission to access the DataStore, regardless of whether or not + /// it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, + /// a NOT_FOUND error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Converses a conversation. - public class ConverseRequest : DiscoveryEngineBaseServiceRequest + /// Gets the method name. + public override string MethodName => "get"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Get parameter list. + protected override void InitParameters() { - /// Constructs a new Converse request. - public ConverseRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest body, string name) : base(service) + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - Name = name; - Body = body; - InitParameters(); - } + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + }); + } + } - /// - /// Required. The resource name of the Conversation to get. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. - /// Use - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` - /// to activate auto session mode, which automatically creates a new conversation inside a - /// ConverseConversation session. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// Gets the SiteSearchEngine. + /// + /// Required. Resource name of SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// If the caller does not have permission to access the [SiteSearchEngine], regardless of whether + /// or not it exists, a PERMISSION_DENIED error is returned. + /// + public virtual GetSiteSearchEngineRequest GetSiteSearchEngine(string name) + { + return new GetSiteSearchEngineRequest(this.service, name); + } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest Body { get; set; } + /// Gets the SiteSearchEngine. + public class GetSiteSearchEngineRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new GetSiteSearchEngine request. + public GetSiteSearchEngineRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// + /// Required. Resource name of SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// If the caller does not have permission to access the [SiteSearchEngine], regardless of + /// whether or not it exists, a PERMISSION_DENIED error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the method name. - public override string MethodName => "converse"; + /// Gets the method name. + public override string MethodName => "getSiteSearchEngine"; - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Gets the REST path. - public override string RestPath => "v1/{+name}:converse"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Initializes Converse parameter list. - protected override void InitParameters() + /// Initializes GetSiteSearchEngine parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", - }); - } + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", + }); } + } - /// - /// Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS - /// error is returned. - /// - /// The body of the request. - /// - /// Required. Full resource name of parent data store. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` - /// - public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation body, string parent) + /// Lists all the DataStores associated with the project. + /// + /// Required. The parent branch resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not + /// have permission to list DataStores under this location, regardless of whether or not this data + /// store exists, a PERMISSION_DENIED error is returned. + /// + public virtual ListRequest List(string parent) + { + return new ListRequest(this.service, parent); + } + + /// Lists all the DataStores associated with the project. + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) { - return new CreateRequest(this.service, body, parent); + Parent = parent; + InitParameters(); } /// - /// Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS - /// error is returned. + /// Required. The parent branch resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does + /// not have permission to list DataStores under this location, regardless of whether or not + /// this data store exists, a PERMISSION_DENIED error is returned. /// - public class CreateRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Create request. - public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation body, string parent) : base(service) - { - Parent = parent; - Body = body; - InitParameters(); - } + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// - /// Required. Full resource name of parent data store. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// + /// Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' + /// + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation Body { get; set; } + /// + /// Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed + /// value is 50. Values above 50 will be coerced to 50. If this field is negative, an + /// INVALID_ARGUMENT is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// + /// A page token ListDataStoresResponse.next_page_token, received from a previous + /// DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When + /// paginating, all other parameters provided to DataStoreService.ListDataStores must match the + /// call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } - /// Gets the method name. - public override string MethodName => "create"; + /// Gets the method name. + public override string MethodName => "list"; - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/conversations"; + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/dataStores"; - /// Initializes Create parameter list. - protected override void InitParameters() + /// Initializes List parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", - }); - } + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+$", + }); + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter + { + Name = "filter", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + + /// Updates a DataStore + /// The body of the request. + /// + /// Immutable. The full resource name of the data store. Format: + /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + /// This field must be a UTF-8 encoded string with a length limit of 1024 characters. + /// + public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string name) + { + return new PatchRequest(this.service, body, name); + } + + /// Updates a DataStore + public class PatchRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Patch request. + public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string name) : base(service) + { + Name = name; + Body = body; + InitParameters(); } /// - /// Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is - /// returned. + /// Immutable. The full resource name of the data store. Format: + /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + /// This field must be a UTF-8 encoded string with a length limit of 1024 characters. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// + /// Indicates which fields in the provided DataStore to update. If an unsupported or unknown + /// field is provided, an INVALID_ARGUMENT error is returned. /// + [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] + public virtual object UpdateMask { get; set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "patch"; + + /// Gets the HTTP method. + public override string HttpMethod => "PATCH"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Patch parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + }); + RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter + { + Name = "updateMask", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + } + + /// Gets the Engines resource. + public virtual EnginesResource Engines { get; } + + /// The "engines" collection of methods. + public class EnginesResource + { + private const string Resource = "engines"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public EnginesResource(Google.Apis.Services.IClientService service) + { + this.service = service; + Conversations = new ConversationsResource(service); + Operations = new OperationsResource(service); + ServingConfigs = new ServingConfigsResource(service); + Sessions = new SessionsResource(service); + } + + /// Gets the Conversations resource. + public virtual ConversationsResource Conversations { get; } + + /// The "conversations" collection of methods. + public class ConversationsResource + { + private const string Resource = "conversations"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public ConversationsResource(Google.Apis.Services.IClientService service) + { + this.service = service; + } + + /// Converses a conversation. + /// The body of the request. /// - /// Required. The resource name of the Conversation to delete. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + /// Required. The resource name of the Conversation to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. + /// Use + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` + /// to activate auto session mode, which automatically creates a new conversation inside a + /// ConverseConversation session. /// - public virtual DeleteRequest Delete(string name) + public virtual ConverseRequest Converse(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest body, string name) { - return new DeleteRequest(this.service, name); + return new ConverseRequest(this.service, body, name); } - /// - /// Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is - /// returned. - /// - public class DeleteRequest : DiscoveryEngineBaseServiceRequest + /// Converses a conversation. + public class ConverseRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Delete request. - public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) + /// Constructs a new Converse request. + public ConverseRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest body, string name) : base(service) { Name = name; + Body = body; InitParameters(); } /// - /// Required. The resource name of the Conversation to delete. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + /// Required. The resource name of the Conversation to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. + /// Use + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` + /// to activate auto session mode, which automatically creates a new conversation inside a + /// ConverseConversation session. /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] public virtual string Name { get; private set; } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + /// Gets the method name. - public override string MethodName => "delete"; + public override string MethodName => "converse"; /// Gets the HTTP method. - public override string HttpMethod => "DELETE"; + public override string HttpMethod => "POST"; /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + public override string RestPath => "v1/{+name}:converse"; - /// Initializes Delete parameter list. + /// Initializes Converse parameter list. protected override void InitParameters() { base.InitParameters(); @@ -5015,10 +5414,132 @@ protected override void InitParameters() } } - /// Gets a Conversation. - /// - /// Required. The resource name of the Conversation to get. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + /// + /// Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS + /// error is returned. + /// + /// The body of the request. + /// + /// Required. Full resource name of parent data store. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation body, string parent) + { + return new CreateRequest(this.service, body, parent); + } + + /// + /// Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS + /// error is returned. + /// + public class CreateRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Create request. + public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } + + /// + /// Required. Full resource name of parent data store. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "create"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/conversations"; + + /// Initializes Create parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + }); + } + } + + /// + /// Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is + /// returned. + /// + /// + /// Required. The resource name of the Conversation to delete. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + /// + public virtual DeleteRequest Delete(string name) + { + return new DeleteRequest(this.service, name); + } + + /// + /// Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is + /// returned. + /// + public class DeleteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Delete request. + public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// + /// Required. The resource name of the Conversation to delete. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets the method name. + public override string MethodName => "delete"; + + /// Gets the HTTP method. + public override string HttpMethod => "DELETE"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Delete parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", + }); + } + } + + /// Gets a Conversation. + /// + /// Required. The resource name of the Conversation to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` /// public virtual GetRequest Get(string name) { @@ -5435,14 +5956,81 @@ public ServingConfigsResource(Google.Apis.Services.IClientService service) this.service = service; } + /// Answer query method. + /// The body of the request. + /// + /// Required. The resource name of the Search serving config, such as + /// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, + /// or + /// `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. + /// This field is used to identify the serving configuration name, set of models used to make + /// the search. + /// + public virtual AnswerRequest Answer(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1AnswerQueryRequest body, string servingConfig) + { + return new AnswerRequest(this.service, body, servingConfig); + } + + /// Answer query method. + public class AnswerRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Answer request. + public AnswerRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1AnswerQueryRequest body, string servingConfig) : base(service) + { + ServingConfig = servingConfig; + Body = body; + InitParameters(); + } + + /// + /// Required. The resource name of the Search serving config, such as + /// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, + /// or + /// `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. + /// This field is used to identify the serving configuration name, set of models used to + /// make the search. + /// + [Google.Apis.Util.RequestParameterAttribute("servingConfig", Google.Apis.Util.RequestParameterType.Path)] + public virtual string ServingConfig { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1AnswerQueryRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "answer"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+servingConfig}:answer"; + + /// Initializes Answer parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("servingConfig", new Google.Apis.Discovery.Parameter + { + Name = "servingConfig", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", + }); + } + } + /// Makes a recommendation, which requires a contextual user event. /// The body of the request. /// /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default - /// serving config is created along with your recommendation engine creation. The engine ID will - /// be used as the ID of the default serving config. For example, for Engine + /// serving config is created along with your recommendation engine creation. The engine ID is + /// used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for /// your RecommendationService.Recommend requests. @@ -5468,7 +6056,7 @@ public RecommendRequest(Google.Apis.Services.IClientService service, Google.Apis /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default /// serving config is created along with your recommendation engine creation. The engine ID - /// will be used as the ID of the default serving config. For example, for Engine + /// is used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` /// for your RecommendationService.Recommend requests. @@ -5574,650 +6162,448 @@ protected override void InitParameters() } } - /// Creates a Engine. - /// The body of the request. - /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}`. - /// - public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine body, string parent) - { - return new CreateRequest(this.service, body, parent); - } + /// Gets the Sessions resource. + public virtual SessionsResource Sessions { get; } - /// Creates a Engine. - public class CreateRequest : DiscoveryEngineBaseServiceRequest + /// The "sessions" collection of methods. + public class SessionsResource { - /// Constructs a new Create request. - public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine body, string parent) : base(service) + private const string Resource = "sessions"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public SessionsResource(Google.Apis.Services.IClientService service) { - Parent = parent; - Body = body; - InitParameters(); + this.service = service; + Answers = new AnswersResource(service); } - /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}`. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// Gets the Answers resource. + public virtual AnswersResource Answers { get; } - /// - /// Required. The ID to use for the Engine, which will become the final component of the - /// Engine's resource name. This field must conform to - /// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 - /// characters. Otherwise, an INVALID_ARGUMENT error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("engineId", Google.Apis.Util.RequestParameterType.Query)] - public virtual string EngineId { get; set; } + /// The "answers" collection of methods. + public class AnswersResource + { + private const string Resource = "answers"; - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine Body { get; set; } + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; - /// Returns the body of the request. - protected override object GetBody() => Body; + /// Constructs a new resource. + public AnswersResource(Google.Apis.Services.IClientService service) + { + this.service = service; + } - /// Gets the method name. - public override string MethodName => "create"; + /// Gets a Answer. + /// + /// Required. The resource name of the Answer to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` + /// + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets a Answer. + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/engines"; + /// + /// Required. The resource name of the Answer to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Initializes Create parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+$", - }); - RequestParameters.Add("engineId", new Google.Apis.Discovery.Parameter - { - Name = "engineId", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } - } + /// Gets the method name. + public override string MethodName => "get"; - /// Deletes a Engine. - /// - /// Required. Full resource name of Engine, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If - /// the caller does not have permission to delete the Engine, regardless of whether or not it - /// exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a - /// NOT_FOUND error is returned. - /// - public virtual DeleteRequest Delete(string name) - { - return new DeleteRequest(this.service, name); - } + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Deletes a Engine. - public class DeleteRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Delete request. - public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Get parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$", + }); + } + } } /// - /// Required. Full resource name of Engine, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. - /// If the caller does not have permission to delete the Engine, regardless of whether or not it - /// exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a - /// NOT_FOUND error is returned. + /// Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is + /// returned. /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } - - /// Gets the method name. - public override string MethodName => "delete"; - - /// Gets the HTTP method. - public override string HttpMethod => "DELETE"; - - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// The body of the request. + /// + /// Required. Full resource name of parent data store. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string parent) + { + return new CreateRequest(this.service, body, parent); + } - /// Initializes Delete parameter list. - protected override void InitParameters() + /// + /// Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is + /// returned. + /// + public class CreateRequest : DiscoveryEngineBaseServiceRequest { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + /// Constructs a new Create request. + public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string parent) : base(service) { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", - }); - } - } + Parent = parent; + Body = body; + InitParameters(); + } - /// Gets a Engine. - /// - /// Required. Full resource name of Engine, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. - /// - public virtual GetRequest Get(string name) - { - return new GetRequest(this.service, name); - } + /// + /// Required. Full resource name of parent data store. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Gets a Engine. - public class GetRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session Body { get; set; } - /// - /// Required. Full resource name of Engine, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the method name. - public override string MethodName => "get"; + /// Gets the method name. + public override string MethodName => "create"; - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Gets the HTTP method. + public override string HttpMethod => "POST"; - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/sessions"; - /// Initializes Get parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + /// Initializes Create parameter list. + protected override void InitParameters() { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", - }); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + }); + } } - } - - /// Lists all the Engines associated with the project. - /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}`. - /// - public virtual ListRequest List(string parent) - { - return new ListRequest(this.service, parent); - } - /// Lists all the Engines associated with the project. - public class ListRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + /// + /// Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + /// + /// + /// Required. The resource name of the Session to delete. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + public virtual DeleteRequest Delete(string name) { - Parent = parent; - InitParameters(); + return new DeleteRequest(this.service, name); } /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}`. + /// Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + public class DeleteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Delete request. + public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } - /// - /// Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH - /// - [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Filter { get; set; } + /// + /// Required. The resource name of the Session to delete. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Optional. Not supported. - [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable PageSize { get; set; } + /// Gets the method name. + public override string MethodName => "delete"; - /// Optional. Not supported. - [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] - public virtual string PageToken { get; set; } + /// Gets the HTTP method. + public override string HttpMethod => "DELETE"; - /// Gets the method name. - public override string MethodName => "list"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Initializes Delete parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", + }); + } + } - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/engines"; + /// Gets a Session. + /// + /// Required. The resource name of the Session to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } - /// Initializes List parameter list. - protected override void InitParameters() + /// Gets a Session. + public class GetRequest : DiscoveryEngineBaseServiceRequest { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+$", - }); - RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter - { - Name = "filter", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter - { - Name = "pageSize", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) { - Name = "pageToken", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } - } - - /// Updates an Engine - /// The body of the request. - /// - /// Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded - /// string with a length limit of 1024 characters. Format: - /// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` - /// engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an - /// INVALID_ARGUMENT error is returned. - /// - public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine body, string name) - { - return new PatchRequest(this.service, body, name); - } - - /// Updates an Engine - public class PatchRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Patch request. - public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine body, string name) : base(service) - { - Name = name; - Body = body; - InitParameters(); - } - - /// - /// Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 - /// encoded string with a length limit of 1024 characters. Format: - /// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` - /// engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an - /// INVALID_ARGUMENT error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } - - /// - /// Indicates which fields in the provided Engine to update. If an unsupported or unknown field - /// is provided, an INVALID_ARGUMENT error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] - public virtual object UpdateMask { get; set; } - - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine Body { get; set; } + Name = name; + InitParameters(); + } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// + /// Required. The resource name of the Session to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the method name. - public override string MethodName => "patch"; + /// Gets the method name. + public override string MethodName => "get"; - /// Gets the HTTP method. - public override string HttpMethod => "PATCH"; + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Initializes Patch parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", - }); - RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter + /// Initializes Get parameter list. + protected override void InitParameters() { - Name = "updateMask", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", + }); + } } - } - } - /// Gets the Operations resource. - public virtual OperationsResource Operations { get; } + /// Lists all Sessions by their parent DataStore. + /// + /// Required. The data store resource name. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + public virtual ListRequest List(string parent) + { + return new ListRequest(this.service, parent); + } - /// The "operations" collection of methods. - public class OperationsResource - { - private const string Resource = "operations"; + /// Lists all Sessions by their parent DataStore. + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + { + Parent = parent; + InitParameters(); + } - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + /// + /// Required. The data store resource name. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Constructs a new resource. - public OperationsResource(Google.Apis.Services.IClientService service) - { - this.service = service; - } + /// + /// A filter to apply on the list results. The supported features are: user_pseudo_id, + /// state. Example: "user_pseudo_id = some_id" + /// + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } - /// - /// 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. - /// - /// The name of the operation resource. - public virtual GetRequest Get(string name) - { - return new GetRequest(this.service, name); - } + /// + /// A comma-separated list of fields to order by, sorted in ascending order. Use "desc" + /// after a field name for descending. Supported fields: * `update_time` * `create_time` * + /// `session_name` Example: "update_time desc" "create_time" + /// + [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)] + public virtual string OrderBy { get; set; } - /// - /// 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. - /// - public class GetRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + /// + /// Maximum number of results to return. If unspecified, defaults to 50. Max allowed value + /// is 1000. + /// + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } - /// The name of the operation resource. - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// + /// A page token, received from a previous `ListSessions` call. Provide this to retrieve the + /// subsequent page. + /// + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } - /// Gets the method name. - public override string MethodName => "get"; + /// Gets the method name. + public override string MethodName => "list"; - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/sessions"; - /// Initializes Get parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + /// Initializes List parameter list. + protected override void InitParameters() { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$", - }); - } - } - - /// - /// Lists operations that match the specified filter in the request. If the server doesn't support - /// this method, it returns `UNIMPLEMENTED`. - /// - /// The name of the operation's parent resource. - public virtual ListRequest List(string name) - { - return new ListRequest(this.service, name); - } - - /// - /// Lists operations that match the specified filter in the request. If the server doesn't support - /// this method, it returns `UNIMPLEMENTED`. - /// - public class ListRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } - - /// The name of the operation's parent resource. - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } - - /// The standard list filter. - [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Filter { get; set; } - - /// The standard list page size. - [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable PageSize { get; set; } - - /// The standard list page token. - [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] - public virtual string PageToken { get; set; } - - /// Gets the method name. - public override string MethodName => "list"; - - /// Gets the HTTP method. - public override string HttpMethod => "GET"; - - /// Gets the REST path. - public override string RestPath => "v1/{+name}/operations"; - - /// Initializes List parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+$", - }); - RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter - { - Name = "filter", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter - { - Name = "pageSize", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter - { - Name = "pageToken", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } - } - } - } - - /// Gets the DataStores resource. - public virtual DataStoresResource DataStores { get; } - - /// The "dataStores" collection of methods. - public class DataStoresResource - { - private const string Resource = "dataStores"; - - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; - - /// Constructs a new resource. - public DataStoresResource(Google.Apis.Services.IClientService service) - { - this.service = service; - Branches = new BranchesResource(service); - Conversations = new ConversationsResource(service); - Models = new ModelsResource(service); - Operations = new OperationsResource(service); - Schemas = new SchemasResource(service); - ServingConfigs = new ServingConfigsResource(service); - SiteSearchEngine = new SiteSearchEngineResource(service); - SuggestionDenyListEntries = new SuggestionDenyListEntriesResource(service); - UserEvents = new UserEventsResource(service); - } - - /// Gets the Branches resource. - public virtual BranchesResource Branches { get; } - - /// The "branches" collection of methods. - public class BranchesResource - { - private const string Resource = "branches"; - - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; - - /// Constructs a new resource. - public BranchesResource(Google.Apis.Services.IClientService service) - { - this.service = service; - Documents = new DocumentsResource(service); - Operations = new OperationsResource(service); - } - - /// Gets the Documents resource. - public virtual DocumentsResource Documents { get; } - - /// The "documents" collection of methods. - public class DocumentsResource - { - private const string Resource = "documents"; - - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; - - /// Constructs a new resource. - public DocumentsResource(Google.Apis.Services.IClientService service) - { - this.service = service; + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + }); + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter + { + Name = "filter", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter + { + Name = "orderBy", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } } - /// Creates a Document. + /// + /// Updates a Session. Session action type cannot be changed. If the Session to update does not + /// exist, a NOT_FOUND error is returned. + /// /// The body of the request. - /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. + /// + /// Immutable. Fully qualified name + /// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` /// - public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document body, string parent) + public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string name) { - return new CreateRequest(this.service, body, parent); + return new PatchRequest(this.service, body, name); } - /// Creates a Document. - public class CreateRequest : DiscoveryEngineBaseServiceRequest + /// + /// Updates a Session. Session action type cannot be changed. If the Session to update does not + /// exist, a NOT_FOUND error is returned. + /// + public class PatchRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Create request. - public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document body, string parent) : base(service) + /// Constructs a new Patch request. + public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string name) : base(service) { - Parent = parent; + Name = name; Body = body; InitParameters(); } /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. + /// Immutable. Fully qualified name + /// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } /// - /// Required. The ID to use for the Document, which will become the final component of the - /// Document.name. If the caller does not have permission to create the Document, regardless - /// of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be - /// unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is - /// returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) - /// standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is - /// returned. + /// Indicates which fields in the provided Session to update. The following are NOT + /// supported: * Session.name If not set or empty, all supported fields are updated. /// - [Google.Apis.Util.RequestParameterAttribute("documentId", Google.Apis.Util.RequestParameterType.Query)] - public virtual string DocumentId { get; set; } + [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] + public virtual object UpdateMask { get; set; } /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document Body { get; set; } + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session Body { get; set; } /// Returns the body of the request. protected override object GetBody() => Body; /// Gets the method name. - public override string MethodName => "create"; + public override string MethodName => "patch"; /// Gets the HTTP method. - public override string HttpMethod => "POST"; + public override string HttpMethod => "PATCH"; /// Gets the REST path. - public override string RestPath => "v1/{+parent}/documents"; + public override string RestPath => "v1/{+name}"; - /// Initializes Create parameter list. + /// Initializes Patch parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - Name = "parent", + Name = "name", IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", }); - RequestParameters.Add("documentId", new Google.Apis.Discovery.Parameter + RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter { - Name = "documentId", + Name = "updateMask", IsRequired = false, ParameterType = "query", DefaultValue = null, @@ -6225,566 +6611,704 @@ protected override void InitParameters() }); } } + } - /// Deletes a Document. - /// - /// Required. Full resource name of Document, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. - /// If the caller does not have permission to delete the Document, regardless of whether or not - /// it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not - /// exist, a `NOT_FOUND` error is returned. - /// - public virtual DeleteRequest Delete(string name) - { - return new DeleteRequest(this.service, name); - } + /// Creates a Engine. + /// The body of the request. + /// + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}`. + /// + public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine body, string parent) + { + return new CreateRequest(this.service, body, parent); + } - /// Deletes a Document. - public class DeleteRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Delete request. - public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + /// Creates a Engine. + public class CreateRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Create request. + public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } - /// - /// Required. Full resource name of Document, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. - /// If the caller does not have permission to delete the Document, regardless of whether or - /// not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does - /// not exist, a `NOT_FOUND` error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Gets the method name. - public override string MethodName => "delete"; + /// + /// Required. The ID to use for the Engine, which will become the final component of the + /// Engine's resource name. This field must conform to + /// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 + /// characters. Otherwise, an INVALID_ARGUMENT error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("engineId", Google.Apis.Util.RequestParameterType.Query)] + public virtual string EngineId { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "DELETE"; + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine Body { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Initializes Delete parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", - }); - } - } + /// Gets the method name. + public override string MethodName => "create"; - /// Gets a Document. - /// - /// Required. Full resource name of Document, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. - /// If the caller does not have permission to access the Document, regardless of whether or not - /// it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not - /// exist, a `NOT_FOUND` error is returned. - /// - public virtual GetRequest Get(string name) + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/engines"; + + /// Initializes Create parameter list. + protected override void InitParameters() { - return new GetRequest(this.service, name); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+$", + }); + RequestParameters.Add("engineId", new Google.Apis.Discovery.Parameter + { + Name = "engineId", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); } + } - /// Gets a Document. - public class GetRequest : DiscoveryEngineBaseServiceRequest + /// Deletes a Engine. + /// + /// Required. Full resource name of Engine, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If + /// the caller does not have permission to delete the Engine, regardless of whether or not it + /// exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a + /// NOT_FOUND error is returned. + /// + public virtual DeleteRequest Delete(string name) + { + return new DeleteRequest(this.service, name); + } + + /// Deletes a Engine. + public class DeleteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Delete request. + public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + Name = name; + InitParameters(); + } - /// - /// Required. Full resource name of Document, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. - /// If the caller does not have permission to access the Document, regardless of whether or - /// not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does - /// not exist, a `NOT_FOUND` error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// + /// Required. Full resource name of Engine, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. + /// If the caller does not have permission to delete the Engine, regardless of whether or not it + /// exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a + /// NOT_FOUND error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the method name. - public override string MethodName => "get"; + /// Gets the method name. + public override string MethodName => "delete"; - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Gets the HTTP method. + public override string HttpMethod => "DELETE"; - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Initializes Get parameter list. - protected override void InitParameters() + /// Initializes Delete parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", - }); - } + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + }); } + } - /// - /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items - /// will be created. Note: It is possible for a subset of the Documents to be successfully - /// updated. - /// - /// The body of the request. - /// - /// Required. The parent branch resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. - /// Requires create/update permission. - /// - public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportDocumentsRequest body, string parent) + /// Gets a Engine. + /// + /// Required. Full resource name of Engine, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. + /// + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } + + /// Gets a Engine. + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) { - return new ImportRequest(this.service, body, parent); + Name = name; + InitParameters(); } /// - /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items - /// will be created. Note: It is possible for a subset of the Documents to be successfully - /// updated. + /// Required. Full resource name of Engine, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. /// - public class ImportRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Import request. - public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportDocumentsRequest body, string parent) : base(service) - { - Parent = parent; - Body = body; - InitParameters(); - } - - /// - /// Required. The parent branch resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. - /// Requires create/update permission. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } - - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportDocumentsRequest Body { get; set; } - - /// Returns the body of the request. - protected override object GetBody() => Body; + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the method name. - public override string MethodName => "import"; + /// Gets the method name. + public override string MethodName => "get"; - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/documents:import"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Initializes Import parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", - }); - } + /// Initializes Get parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + }); } + } - /// Gets a list of Documents. - /// - /// Required. The parent branch resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. - /// Use `default_branch` as the branch ID, to list documents under the default branch. If the - /// caller does not have permission to list Documents under this branch, regardless of whether - /// or not this branch exists, a `PERMISSION_DENIED` error is returned. - /// - public virtual ListRequest List(string parent) + /// Lists all the Engines associated with the project. + /// + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}`. + /// + public virtual ListRequest List(string parent) + { + return new ListRequest(this.service, parent); + } + + /// Lists all the Engines associated with the project. + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) { - return new ListRequest(this.service, parent); + Parent = parent; + InitParameters(); } - /// Gets a list of Documents. - public class ListRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) - { - Parent = parent; - InitParameters(); - } + /// + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// - /// Required. The parent branch resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. - /// Use `default_branch` as the branch ID, to list documents under the default branch. If - /// the caller does not have permission to list Documents under this branch, regardless of - /// whether or not this branch exists, a `PERMISSION_DENIED` error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// + /// Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH + /// + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } - /// - /// Maximum number of Documents to return. If unspecified, defaults to 100. The maximum - /// allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is - /// negative, an `INVALID_ARGUMENT` error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable PageSize { get; set; } + /// Optional. Not supported. + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } - /// - /// A page token ListDocumentsResponse.next_page_token, received from a previous - /// DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When - /// paginating, all other parameters provided to DocumentService.ListDocuments must match - /// the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is - /// returned. - /// - [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] - public virtual string PageToken { get; set; } + /// Optional. Not supported. + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } - /// Gets the method name. - public override string MethodName => "list"; + /// Gets the method name. + public override string MethodName => "list"; - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/documents"; + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/engines"; - /// Initializes List parameter list. - protected override void InitParameters() + /// Initializes List parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", - }); - RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter - { - Name = "pageSize", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter - { - Name = "pageToken", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+$", + }); + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter + { + Name = "filter", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); } + } - /// Updates a Document. - /// The body of the request. - /// - /// 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. - /// - public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document body, string name) - { - return new PatchRequest(this.service, body, name); - } + /// Updates an Engine + /// The body of the request. + /// + /// Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded + /// string with a length limit of 1024 characters. Format: + /// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` + /// engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an + /// INVALID_ARGUMENT error is returned. + /// + public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine body, string name) + { + return new PatchRequest(this.service, body, name); + } - /// Updates a Document. - public class PatchRequest : DiscoveryEngineBaseServiceRequest + /// Updates an Engine + public class PatchRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Patch request. + public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine body, string name) : base(service) { - /// Constructs a new Patch request. - public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document body, string name) : base(service) - { - Name = name; - Body = body; - InitParameters(); - } + Name = name; + Body = body; + InitParameters(); + } - /// - /// 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. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// + /// Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 + /// encoded string with a length limit of 1024 characters. Format: + /// `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` + /// engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an + /// INVALID_ARGUMENT error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// - /// If set to true, and the Document is not found, a new Document will be created. - /// - [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable AllowMissing { get; set; } + /// + /// Indicates which fields in the provided Engine to update. If an unsupported or unknown field + /// is provided, an INVALID_ARGUMENT error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] + public virtual object UpdateMask { get; set; } - /// - /// Indicates which fields in the provided imported 'document' to update. If not set, will - /// by default update all fields. - /// - [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] - public virtual object UpdateMask { get; set; } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Engine Body { get; set; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document Body { get; set; } + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Returns the body of the request. - protected override object GetBody() => Body; + /// Gets the method name. + public override string MethodName => "patch"; - /// Gets the method name. - public override string MethodName => "patch"; - - /// Gets the HTTP method. - public override string HttpMethod => "PATCH"; + /// Gets the HTTP method. + public override string HttpMethod => "PATCH"; - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Initializes Patch parameter list. - protected override void InitParameters() + /// Initializes Patch parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", - }); - RequestParameters.Add("allowMissing", new Google.Apis.Discovery.Parameter - { - Name = "allowMissing", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter - { - Name = "updateMask", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + }); + RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter + { + Name = "updateMask", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); } + } + } - /// - /// Permanently deletes all selected Documents in a branch. This process is asynchronous. - /// Depending on the number of Documents to be deleted, this operation can take hours to - /// complete. Before the delete operation completes, some Documents might still be returned by - /// DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents - /// to be deleted, set PurgeDocumentsRequest.force to false. - /// - /// The body of the request. - /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. - /// - public virtual PurgeRequest Purge(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeDocumentsRequest body, string parent) - { - return new PurgeRequest(this.service, body, parent); - } + /// Gets the Operations resource. + public virtual OperationsResource Operations { get; } - /// - /// Permanently deletes all selected Documents in a branch. This process is asynchronous. - /// Depending on the number of Documents to be deleted, this operation can take hours to - /// complete. Before the delete operation completes, some Documents might still be returned by - /// DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents - /// to be deleted, set PurgeDocumentsRequest.force to false. - /// - public class PurgeRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Purge request. - public PurgeRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeDocumentsRequest body, string parent) : base(service) - { - Parent = parent; - Body = body; - InitParameters(); - } + /// The "operations" collection of methods. + public class OperationsResource + { + private const string Resource = "operations"; - /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeDocumentsRequest Body { get; set; } + /// Constructs a new resource. + public OperationsResource(Google.Apis.Services.IClientService service) + { + this.service = service; + } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// + /// 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. + /// + /// The name of the operation resource. + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } - /// Gets the method name. - public override string MethodName => "purge"; + /// + /// 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. + /// + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// The name of the operation resource. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/documents:purge"; + /// Gets the method name. + public override string MethodName => "get"; - /// Initializes Purge parameter list. - protected override void InitParameters() + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Get parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", - }); - } + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$", + }); } } - /// Gets the Operations resource. - public virtual OperationsResource Operations { get; } - - /// The "operations" collection of methods. - public class OperationsResource + /// + /// Lists operations that match the specified filter in the request. If the server doesn't support + /// this method, it returns `UNIMPLEMENTED`. + /// + /// The name of the operation's parent resource. + public virtual ListRequest List(string name) { - private const string Resource = "operations"; - - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + return new ListRequest(this.service, name); + } - /// Constructs a new resource. - public OperationsResource(Google.Apis.Services.IClientService service) + /// + /// Lists operations that match the specified filter in the request. If the server doesn't support + /// this method, it returns `UNIMPLEMENTED`. + /// + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) { - this.service = service; + Name = name; + InitParameters(); } - /// - /// 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`. - /// - /// The body of the request. - /// The name of the operation resource to be cancelled. - public virtual CancelRequest Cancel(Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest body, string name) - { - return new CancelRequest(this.service, body, name); - } + /// The name of the operation's parent resource. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// - /// 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`. - /// - public class CancelRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Cancel request. - public CancelRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest body, string name) : base(service) - { - Name = name; - Body = body; - InitParameters(); - } + /// The standard list filter. + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } - /// The name of the operation resource to be cancelled. - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// The standard list page size. + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest Body { get; set; } + /// The standard list page token. + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } + + /// Gets the method name. + public override string MethodName => "list"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}/operations"; + + /// Initializes List parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/collections/[^/]+$", + }); + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter + { + Name = "filter", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + } + } + + /// Gets the DataStores resource. + public virtual DataStoresResource DataStores { get; } + + /// The "dataStores" collection of methods. + public class DataStoresResource + { + private const string Resource = "dataStores"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public DataStoresResource(Google.Apis.Services.IClientService service) + { + this.service = service; + Branches = new BranchesResource(service); + Conversations = new ConversationsResource(service); + Models = new ModelsResource(service); + Operations = new OperationsResource(service); + Schemas = new SchemasResource(service); + ServingConfigs = new ServingConfigsResource(service); + Sessions = new SessionsResource(service); + SiteSearchEngine = new SiteSearchEngineResource(service); + SuggestionDenyListEntries = new SuggestionDenyListEntriesResource(service); + UserEvents = new UserEventsResource(service); + } + + /// Gets the Branches resource. + public virtual BranchesResource Branches { get; } + + /// The "branches" collection of methods. + public class BranchesResource + { + private const string Resource = "branches"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public BranchesResource(Google.Apis.Services.IClientService service) + { + this.service = service; + Documents = new DocumentsResource(service); + Operations = new OperationsResource(service); + } + + /// Gets the Documents resource. + public virtual DocumentsResource Documents { get; } + + /// The "documents" collection of methods. + public class DocumentsResource + { + private const string Resource = "documents"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public DocumentsResource(Google.Apis.Services.IClientService service) + { + this.service = service; + } + + /// Creates a Document. + /// The body of the request. + /// + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. + /// + public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document body, string parent) + { + return new CreateRequest(this.service, body, parent); + } + + /// Creates a Document. + public class CreateRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Create request. + public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } + + /// + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// + /// Required. The ID to use for the Document, which becomes the final component of the + /// Document.name. If the caller does not have permission to create the Document, regardless + /// of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be + /// unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is + /// returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) + /// standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is + /// returned. + /// + [Google.Apis.Util.RequestParameterAttribute("documentId", Google.Apis.Util.RequestParameterType.Query)] + public virtual string DocumentId { get; set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document Body { get; set; } /// Returns the body of the request. protected override object GetBody() => Body; /// Gets the method name. - public override string MethodName => "cancel"; + public override string MethodName => "create"; /// Gets the HTTP method. public override string HttpMethod => "POST"; /// Gets the REST path. - public override string RestPath => "v1/{+name}:cancel"; + public override string RestPath => "v1/{+parent}/documents"; - /// Initializes Cancel parameter list. + /// Initializes Create parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter { - Name = "name", + Name = "parent", IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", + }); + RequestParameters.Add("documentId", new Google.Apis.Discovery.Parameter + { + Name = "documentId", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, }); } } - /// - /// 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. - /// - /// The name of the operation resource. - public virtual GetRequest Get(string name) + /// Deletes a Document. + /// + /// Required. Full resource name of Document, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + /// If the caller does not have permission to delete the Document, regardless of whether or not + /// it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not + /// exist, a `NOT_FOUND` error is returned. + /// + public virtual DeleteRequest Delete(string name) { - return new GetRequest(this.service, name); + return new DeleteRequest(this.service, name); } - /// - /// 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. - /// - public class GetRequest : DiscoveryEngineBaseServiceRequest + /// Deletes a Document. + public class DeleteRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + /// Constructs a new Delete request. + public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) { Name = name; InitParameters(); } - /// The name of the operation resource. + /// + /// Required. Full resource name of Document, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + /// If the caller does not have permission to delete the Document, regardless of whether or + /// not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does + /// not exist, a `NOT_FOUND` error is returned. + /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] public virtual string Name { get; private set; } /// Gets the method name. - public override string MethodName => "get"; + public override string MethodName => "delete"; /// Gets the HTTP method. - public override string HttpMethod => "GET"; + public override string HttpMethod => "DELETE"; /// Gets the REST path. public override string RestPath => "v1/{+name}"; - /// Initializes Get parameter list. + /// Initializes Delete parameter list. protected override void InitParameters() { base.InitParameters(); @@ -6794,47 +7318,183 @@ protected override void InitParameters() IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", }); } } - /// - /// Lists operations that match the specified filter in the request. If the server doesn't - /// support this method, it returns `UNIMPLEMENTED`. - /// - /// The name of the operation's parent resource. - public virtual ListRequest List(string name) + /// Gets a Document. + /// + /// Required. Full resource name of Document, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + /// If the caller does not have permission to access the Document, regardless of whether or not + /// it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not + /// exist, a `NOT_FOUND` error is returned. + /// + public virtual GetRequest Get(string name) { - return new ListRequest(this.service, name); + return new GetRequest(this.service, name); } - /// - /// Lists operations that match the specified filter in the request. If the server doesn't - /// support this method, it returns `UNIMPLEMENTED`. - /// - public class ListRequest : DiscoveryEngineBaseServiceRequest + /// Gets a Document. + public class GetRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) { Name = name; InitParameters(); } - /// The name of the operation's parent resource. + /// + /// Required. Full resource name of Document, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + /// If the caller does not have permission to access the Document, regardless of whether or + /// not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does + /// not exist, a `NOT_FOUND` error is returned. + /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] public virtual string Name { get; private set; } - /// The standard list filter. - [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Filter { get; set; } + /// Gets the method name. + public override string MethodName => "get"; - /// The standard list page size. + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Get parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", + }); + } + } + + /// + /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items + /// are created. Note: It is possible for a subset of the Documents to be successfully updated. + /// + /// The body of the request. + /// + /// Required. The parent branch resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. + /// Requires create/update permission. + /// + public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportDocumentsRequest body, string parent) + { + return new ImportRequest(this.service, body, parent); + } + + /// + /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items + /// are created. Note: It is possible for a subset of the Documents to be successfully updated. + /// + public class ImportRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Import request. + public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportDocumentsRequest body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } + + /// + /// Required. The parent branch resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. + /// Requires create/update permission. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportDocumentsRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "import"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/documents:import"; + + /// Initializes Import parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", + }); + } + } + + /// Gets a list of Documents. + /// + /// Required. The parent branch resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. + /// Use `default_branch` as the branch ID, to list documents under the default branch. If the + /// caller does not have permission to list Documents under this branch, regardless of whether + /// or not this branch exists, a `PERMISSION_DENIED` error is returned. + /// + public virtual ListRequest List(string parent) + { + return new ListRequest(this.service, parent); + } + + /// Gets a list of Documents. + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + { + Parent = parent; + InitParameters(); + } + + /// + /// Required. The parent branch resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. + /// Use `default_branch` as the branch ID, to list documents under the default branch. If + /// the caller does not have permission to list Documents under this branch, regardless of + /// whether or not this branch exists, a `PERMISSION_DENIED` error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// + /// Maximum number of Documents to return. If unspecified, defaults to 100. The maximum + /// allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an + /// `INVALID_ARGUMENT` error is returned. + /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } - /// The standard list page token. + /// + /// A page token ListDocumentsResponse.next_page_token, received from a previous + /// DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When + /// paginating, all other parameters provided to DocumentService.ListDocuments must match + /// the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is + /// returned. + /// [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] public virtual string PageToken { get; set; } @@ -6845,28 +7505,20 @@ public ListRequest(Google.Apis.Services.IClientService service, string name) : b public override string HttpMethod => "GET"; /// Gets the REST path. - public override string RestPath => "v1/{+name}/operations"; + public override string RestPath => "v1/{+parent}/documents"; /// Initializes List parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter { - Name = "name", + Name = "parent", IsRequired = true, ParameterType = "path", DefaultValue = null, Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", }); - RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter - { - Name = "filter", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter { Name = "pageSize", @@ -6885,252 +7537,465 @@ protected override void InitParameters() }); } } - } - } - - /// Gets the Conversations resource. - public virtual ConversationsResource Conversations { get; } - - /// The "conversations" collection of methods. - public class ConversationsResource - { - private const string Resource = "conversations"; - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + /// Updates a Document. + /// The body of the request. + /// + /// 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. + /// + public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document body, string name) + { + return new PatchRequest(this.service, body, name); + } - /// Constructs a new resource. - public ConversationsResource(Google.Apis.Services.IClientService service) - { - this.service = service; - } + /// Updates a Document. + public class PatchRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Patch request. + public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document body, string name) : base(service) + { + Name = name; + Body = body; + InitParameters(); + } - /// Converses a conversation. - /// The body of the request. - /// - /// Required. The resource name of the Conversation to get. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. - /// Use - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` - /// to activate auto session mode, which automatically creates a new conversation inside a - /// ConverseConversation session. - /// - public virtual ConverseRequest Converse(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest body, string name) - { - return new ConverseRequest(this.service, body, name); - } + /// + /// 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. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Converses a conversation. - public class ConverseRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Converse request. - public ConverseRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest body, string name) : base(service) - { - Name = name; - Body = body; - InitParameters(); - } + /// + /// If set to `true` and the Document is not found, a new Document is be created. + /// + [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable AllowMissing { get; set; } - /// - /// Required. The resource name of the Conversation to get. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. - /// Use - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` - /// to activate auto session mode, which automatically creates a new conversation inside a - /// ConverseConversation session. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// + /// Indicates which fields in the provided imported 'document' to update. If not set, by + /// default updates all fields. + /// + [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] + public virtual object UpdateMask { get; set; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest Body { get; set; } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Document Body { get; set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the method name. - public override string MethodName => "converse"; + /// Gets the method name. + public override string MethodName => "patch"; - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the HTTP method. + public override string HttpMethod => "PATCH"; - /// Gets the REST path. - public override string RestPath => "v1/{+name}:converse"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Initializes Converse parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + /// Initializes Patch parameter list. + protected override void InitParameters() { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", - }); + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", + }); + RequestParameters.Add("allowMissing", new Google.Apis.Discovery.Parameter + { + Name = "allowMissing", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter + { + Name = "updateMask", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } } - } - - /// - /// Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is - /// returned. - /// - /// The body of the request. - /// - /// Required. Full resource name of parent data store. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` - /// - public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation body, string parent) - { - return new CreateRequest(this.service, body, parent); - } - /// - /// Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is - /// returned. - /// - public class CreateRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Create request. - public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation body, string parent) : base(service) + /// + /// Permanently deletes all selected Documents in a branch. This process is asynchronous. + /// Depending on the number of Documents to be deleted, this operation can take hours to + /// complete. Before the delete operation completes, some Documents might still be returned by + /// DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents + /// to be deleted, set PurgeDocumentsRequest.force to false. + /// + /// The body of the request. + /// + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. + /// + public virtual PurgeRequest Purge(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeDocumentsRequest body, string parent) { - Parent = parent; - Body = body; - InitParameters(); + return new PurgeRequest(this.service, body, parent); } /// - /// Required. Full resource name of parent data store. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// Permanently deletes all selected Documents in a branch. This process is asynchronous. + /// Depending on the number of Documents to be deleted, this operation can take hours to + /// complete. Before the delete operation completes, some Documents might still be returned by + /// DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents + /// to be deleted, set PurgeDocumentsRequest.force to false. /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + public class PurgeRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Purge request. + public PurgeRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeDocumentsRequest body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation Body { get; set; } + /// + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeDocumentsRequest Body { get; set; } - /// Gets the method name. - public override string MethodName => "create"; + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the method name. + public override string MethodName => "purge"; - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/conversations"; + /// Gets the HTTP method. + public override string HttpMethod => "POST"; - /// Initializes Create parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/documents:purge"; + + /// Initializes Purge parameter list. + protected override void InitParameters() { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", - }); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", + }); + } } } - /// - /// Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is - /// returned. - /// - /// - /// Required. The resource name of the Conversation to delete. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` - /// - public virtual DeleteRequest Delete(string name) - { - return new DeleteRequest(this.service, name); - } + /// Gets the Operations resource. + public virtual OperationsResource Operations { get; } - /// - /// Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is - /// returned. - /// - public class DeleteRequest : DiscoveryEngineBaseServiceRequest + /// The "operations" collection of methods. + public class OperationsResource { - /// Constructs a new Delete request. - public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) + private const string Resource = "operations"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public OperationsResource(Google.Apis.Services.IClientService service) { - Name = name; - InitParameters(); + this.service = service; } /// - /// Required. The resource name of the Conversation to delete. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + /// 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`. /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// The body of the request. + /// The name of the operation resource to be cancelled. + public virtual CancelRequest Cancel(Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest body, string name) + { + return new CancelRequest(this.service, body, name); + } - /// Gets the method name. - public override string MethodName => "delete"; + /// + /// 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`. + /// + public class CancelRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Cancel request. + public CancelRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest body, string name) : base(service) + { + Name = name; + Body = body; + InitParameters(); + } - /// Gets the HTTP method. - public override string HttpMethod => "DELETE"; + /// The name of the operation resource to be cancelled. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest Body { get; set; } - /// Initializes Delete parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", - }); - } - } + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets a Conversation. - /// - /// Required. The resource name of the Conversation to get. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` - /// - public virtual GetRequest Get(string name) - { - return new GetRequest(this.service, name); - } + /// Gets the method name. + public override string MethodName => "cancel"; - /// Gets a Conversation. - public class GetRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}:cancel"; + + /// Initializes Cancel parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", + }); + } + } + + /// + /// 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. + /// + /// The name of the operation resource. + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } + + /// + /// 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. + /// + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// The name of the operation resource. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets the method name. + public override string MethodName => "get"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Get parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", + }); + } + } + + /// + /// Lists operations that match the specified filter in the request. If the server doesn't + /// support this method, it returns `UNIMPLEMENTED`. + /// + /// The name of the operation's parent resource. + public virtual ListRequest List(string name) + { + return new ListRequest(this.service, name); + } + + /// + /// Lists operations that match the specified filter in the request. If the server doesn't + /// support this method, it returns `UNIMPLEMENTED`. + /// + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// The name of the operation's parent resource. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// The standard list filter. + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } + + /// The standard list page size. + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } + + /// The standard list page token. + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } + + /// Gets the method name. + public override string MethodName => "list"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}/operations"; + + /// Initializes List parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", + }); + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter + { + Name = "filter", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + } + } + + /// Gets the Conversations resource. + public virtual ConversationsResource Conversations { get; } + + /// The "conversations" collection of methods. + public class ConversationsResource + { + private const string Resource = "conversations"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public ConversationsResource(Google.Apis.Services.IClientService service) + { + this.service = service; + } + + /// Converses a conversation. + /// The body of the request. + /// + /// Required. The resource name of the Conversation to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. + /// Use + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` + /// to activate auto session mode, which automatically creates a new conversation inside a + /// ConverseConversation session. + /// + public virtual ConverseRequest Converse(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest body, string name) + { + return new ConverseRequest(this.service, body, name); + } + + /// Converses a conversation. + public class ConverseRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Converse request. + public ConverseRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest body, string name) : base(service) { Name = name; + Body = body; InitParameters(); } /// /// Required. The resource name of the Conversation to get. Format: - /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. + /// Use + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` + /// to activate auto session mode, which automatically creates a new conversation inside a + /// ConverseConversation session. /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] public virtual string Name { get; private set; } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ConverseConversationRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + /// Gets the method name. - public override string MethodName => "get"; + public override string MethodName => "converse"; /// Gets the HTTP method. - public override string HttpMethod => "GET"; + public override string HttpMethod => "POST"; /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + public override string RestPath => "v1/{+name}:converse"; - /// Initializes Get parameter list. + /// Initializes Converse parameter list. protected override void InitParameters() { base.InitParameters(); @@ -7145,41 +8010,214 @@ protected override void InitParameters() } } - /// Lists all Conversations by their parent DataStore. + /// + /// Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is + /// returned. + /// + /// The body of the request. /// - /// Required. The data store resource name. Format: + /// Required. Full resource name of parent data store. Format: /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` /// - public virtual ListRequest List(string parent) + public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation body, string parent) { - return new ListRequest(this.service, parent); + return new CreateRequest(this.service, body, parent); } - /// Lists all Conversations by their parent DataStore. - public class ListRequest : DiscoveryEngineBaseServiceRequest + /// + /// Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is + /// returned. + /// + public class CreateRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + /// Constructs a new Create request. + public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation body, string parent) : base(service) { Parent = parent; + Body = body; InitParameters(); } /// - /// Required. The data store resource name. Format: + /// Required. Full resource name of parent data store. Format: /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` /// [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] public virtual string Parent { get; private set; } - /// - /// A filter to apply on the list results. The supported features are: user_pseudo_id, state. - /// Example: "user_pseudo_id = some_id" - /// - [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Filter { get; set; } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Conversation Body { get; set; } - /// + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "create"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/conversations"; + + /// Initializes Create parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + }); + } + } + + /// + /// Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is + /// returned. + /// + /// + /// Required. The resource name of the Conversation to delete. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + /// + public virtual DeleteRequest Delete(string name) + { + return new DeleteRequest(this.service, name); + } + + /// + /// Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is + /// returned. + /// + public class DeleteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Delete request. + public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// + /// Required. The resource name of the Conversation to delete. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets the method name. + public override string MethodName => "delete"; + + /// Gets the HTTP method. + public override string HttpMethod => "DELETE"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Delete parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", + }); + } + } + + /// Gets a Conversation. + /// + /// Required. The resource name of the Conversation to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + /// + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } + + /// Gets a Conversation. + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// + /// Required. The resource name of the Conversation to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets the method name. + public override string MethodName => "get"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Get parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", + }); + } + } + + /// Lists all Conversations by their parent DataStore. + /// + /// Required. The data store resource name. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + public virtual ListRequest List(string parent) + { + return new ListRequest(this.service, parent); + } + + /// Lists all Conversations by their parent DataStore. + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + { + Parent = parent; + InitParameters(); + } + + /// + /// Required. The data store resource name. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// + /// A filter to apply on the list results. The supported features are: user_pseudo_id, state. + /// Example: "user_pseudo_id = some_id" + /// + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } + + /// /// A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a /// field name for descending. Supported fields: * `update_time` * `create_time` * /// `conversation_name` Example: "update_time desc" "create_time" @@ -7718,7 +8756,7 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Di public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the Schema, which will become the final component of the + /// Required. The ID to use for the Schema, which becomes the final component of the /// Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) /// standard with a length limit of 63 characters. /// @@ -7894,8 +8932,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// The maximum number of Schemas to return. The service may return fewer than this value. If - /// unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above - /// 1000 will be coerced to 1000. + /// unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 + /// are set to 1000. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -7980,8 +9018,8 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis public virtual string Name { get; private set; } /// - /// If set to true, and the Schema is not found, a new Schema will be created. In this - /// situation, `update_mask` is ignored. + /// If set to true, and the Schema is not found, a new Schema is created. In this situation, + /// `update_mask` is ignored. /// [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable AllowMissing { get; set; } @@ -8042,14 +9080,81 @@ public ServingConfigsResource(Google.Apis.Services.IClientService service) this.service = service; } + /// Answer query method. + /// The body of the request. + /// + /// Required. The resource name of the Search serving config, such as + /// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, + /// or + /// `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. + /// This field is used to identify the serving configuration name, set of models used to make the + /// search. + /// + public virtual AnswerRequest Answer(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1AnswerQueryRequest body, string servingConfig) + { + return new AnswerRequest(this.service, body, servingConfig); + } + + /// Answer query method. + public class AnswerRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Answer request. + public AnswerRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1AnswerQueryRequest body, string servingConfig) : base(service) + { + ServingConfig = servingConfig; + Body = body; + InitParameters(); + } + + /// + /// Required. The resource name of the Search serving config, such as + /// `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, + /// or + /// `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. + /// This field is used to identify the serving configuration name, set of models used to make + /// the search. + /// + [Google.Apis.Util.RequestParameterAttribute("servingConfig", Google.Apis.Util.RequestParameterType.Path)] + public virtual string ServingConfig { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1AnswerQueryRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "answer"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+servingConfig}:answer"; + + /// Initializes Answer parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("servingConfig", new Google.Apis.Discovery.Parameter + { + Name = "servingConfig", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", + }); + } + } + /// Makes a recommendation, which requires a contextual user event. /// The body of the request. /// /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving - /// config is created along with your recommendation engine creation. The engine ID will be used as - /// the ID of the default serving config. For example, for Engine + /// config is created along with your recommendation engine creation. The engine ID is used as the + /// ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your /// RecommendationService.Recommend requests. @@ -8074,8 +9179,8 @@ public RecommendRequest(Google.Apis.Services.IClientService service, Google.Apis /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default - /// serving config is created along with your recommendation engine creation. The engine ID will - /// be used as the ID of the default serving config. For example, for Engine + /// serving config is created along with your recommendation engine creation. The engine ID is + /// used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for /// your RecommendationService.Recommend requests. @@ -8181,2272 +9286,3588 @@ protected override void InitParameters() } } - /// Gets the SiteSearchEngine resource. - public virtual SiteSearchEngineResource SiteSearchEngine { get; } + /// Gets the Sessions resource. + public virtual SessionsResource Sessions { get; } - /// The "siteSearchEngine" collection of methods. - public class SiteSearchEngineResource + /// The "sessions" collection of methods. + public class SessionsResource { - private const string Resource = "siteSearchEngine"; + private const string Resource = "sessions"; /// The service which this resource belongs to. private readonly Google.Apis.Services.IClientService service; /// Constructs a new resource. - public SiteSearchEngineResource(Google.Apis.Services.IClientService service) + public SessionsResource(Google.Apis.Services.IClientService service) { this.service = service; - TargetSites = new TargetSitesResource(service); + Answers = new AnswersResource(service); } - /// Gets the TargetSites resource. - public virtual TargetSitesResource TargetSites { get; } + /// Gets the Answers resource. + public virtual AnswersResource Answers { get; } - /// The "targetSites" collection of methods. - public class TargetSitesResource + /// The "answers" collection of methods. + public class AnswersResource { - private const string Resource = "targetSites"; + private const string Resource = "answers"; /// The service which this resource belongs to. private readonly Google.Apis.Services.IClientService service; /// Constructs a new resource. - public TargetSitesResource(Google.Apis.Services.IClientService service) + public AnswersResource(Google.Apis.Services.IClientService service) { this.service = service; } - /// Creates TargetSite in a batch. - /// The body of the request. - /// - /// Required. The parent resource shared by all TargetSites being created. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// The parent field in the CreateBookRequest messages must either be empty or match this field. + /// Gets a Answer. + /// + /// Required. The resource name of the Answer to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` /// - public virtual BatchCreateRequest BatchCreate(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest body, string parent) + public virtual GetRequest Get(string name) { - return new BatchCreateRequest(this.service, body, parent); + return new GetRequest(this.service, name); } - /// Creates TargetSite in a batch. - public class BatchCreateRequest : DiscoveryEngineBaseServiceRequest + /// Gets a Answer. + public class GetRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new BatchCreate request. - public BatchCreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest body, string parent) : base(service) + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) { - Parent = parent; - Body = body; + Name = name; InitParameters(); } /// - /// Required. The parent resource shared by all TargetSites being created. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// The parent field in the CreateBookRequest messages must either be empty or match this - /// field. + /// Required. The resource name of the Answer to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } - - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest Body { get; set; } - - /// Returns the body of the request. - protected override object GetBody() => Body; + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } /// Gets the method name. - public override string MethodName => "batchCreate"; + public override string MethodName => "get"; /// Gets the HTTP method. - public override string HttpMethod => "POST"; + public override string HttpMethod => "GET"; /// Gets the REST path. - public override string RestPath => "v1/{+parent}/targetSites:batchCreate"; + public override string RestPath => "v1/{+name}"; - /// Initializes BatchCreate parameter list. + /// Initializes Get parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - Name = "parent", + Name = "name", IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", }); } } + } - /// Creates a TargetSite. - /// The body of the request. - /// - /// Required. Parent resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// - public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string parent) - { - return new CreateRequest(this.service, body, parent); - } + /// + /// Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + /// + /// The body of the request. + /// + /// Required. Full resource name of parent data store. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string parent) + { + return new CreateRequest(this.service, body, parent); + } - /// Creates a TargetSite. - public class CreateRequest : DiscoveryEngineBaseServiceRequest + /// + /// Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + /// + public class CreateRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Create request. + public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string parent) : base(service) { - /// Constructs a new Create request. - public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string parent) : base(service) - { - Parent = parent; - Body = body; - InitParameters(); - } + Parent = parent; + Body = body; + InitParameters(); + } - /// - /// Required. Parent resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// + /// Required. Full resource name of parent data store. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite Body { get; set; } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session Body { get; set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the method name. - public override string MethodName => "create"; + /// Gets the method name. + public override string MethodName => "create"; - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the HTTP method. + public override string HttpMethod => "POST"; - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/targetSites"; + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/sessions"; - /// Initializes Create parameter list. - protected override void InitParameters() + /// Initializes Create parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", - }); - } + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + }); } + } - /// Deletes a TargetSite. - /// - /// Required. Full resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. - /// If the caller does not have permission to access the TargetSite, regardless of whether or - /// not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not - /// exist, a NOT_FOUND error is returned. - /// - public virtual DeleteRequest Delete(string name) - { - return new DeleteRequest(this.service, name); - } + /// + /// Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + /// + /// + /// Required. The resource name of the Session to delete. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + public virtual DeleteRequest Delete(string name) + { + return new DeleteRequest(this.service, name); + } - /// Deletes a TargetSite. - public class DeleteRequest : DiscoveryEngineBaseServiceRequest + /// + /// Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + /// + public class DeleteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Delete request. + public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) { - /// Constructs a new Delete request. - public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + Name = name; + InitParameters(); + } - /// - /// Required. Full resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. - /// If the caller does not have permission to access the TargetSite, regardless of whether - /// or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite - /// does not exist, a NOT_FOUND error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// + /// Required. The resource name of the Session to delete. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the method name. - public override string MethodName => "delete"; + /// Gets the method name. + public override string MethodName => "delete"; - /// Gets the HTTP method. - public override string HttpMethod => "DELETE"; + /// Gets the HTTP method. + public override string HttpMethod => "DELETE"; - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Initializes Delete parameter list. - protected override void InitParameters() + /// Initializes Delete parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", - }); - } + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + }); } + } - /// Gets a TargetSite. - /// - /// Required. Full resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. - /// If the caller does not have permission to access the TargetSite, regardless of whether or - /// not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not - /// exist, a NOT_FOUND error is returned. - /// - public virtual GetRequest Get(string name) + /// Gets a Session. + /// + /// Required. The resource name of the Session to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } + + /// Gets a Session. + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) { - return new GetRequest(this.service, name); + Name = name; + InitParameters(); } - /// Gets a TargetSite. - public class GetRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + /// + /// Required. The resource name of the Session to get. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// - /// Required. Full resource name of TargetSite, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. - /// If the caller does not have permission to access the TargetSite, regardless of whether - /// or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite - /// does not exist, a NOT_FOUND error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// Gets the method name. + public override string MethodName => "get"; - /// Gets the method name. - public override string MethodName => "get"; + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Gets the HTTP method. - public override string HttpMethod => "GET"; - - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; - - /// Initializes Get parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", - }); - } - } - - /// Gets a list of TargetSites. - /// - /// Required. The parent site search engine resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// If the caller does not have permission to list TargetSites under this site search engine, - /// regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. - /// - public virtual ListRequest List(string parent) - { - return new ListRequest(this.service, parent); - } - - /// Gets a list of TargetSites. - public class ListRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) - { - Parent = parent; - InitParameters(); - } - - /// - /// Required. The parent site search engine resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// If the caller does not have permission to list TargetSites under this site search - /// engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is - /// returned. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } - - /// - /// Requested page size. Server may return fewer items than requested. If unspecified, - /// server will pick an appropriate default. The maximum value is 1000; values above 1000 - /// will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is - /// returned. - /// - [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable PageSize { get; set; } - - /// - /// A page token, received from a previous `ListTargetSites` call. Provide this to retrieve - /// the subsequent page. When paginating, all other parameters provided to `ListTargetSites` - /// must match the call that provided the page token. - /// - [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] - public virtual string PageToken { get; set; } - - /// Gets the method name. - public override string MethodName => "list"; - - /// Gets the HTTP method. - public override string HttpMethod => "GET"; - - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/targetSites"; - - /// Initializes List parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", - }); - RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter - { - Name = "pageSize", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter - { - Name = "pageToken", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } - } - - /// Updates a TargetSite. - /// The body of the request. - /// - /// Output only. The fully qualified resource name of the target site. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` - /// The `target_site_id` is system-generated. - /// - public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string name) - { - return new PatchRequest(this.service, body, name); - } + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Updates a TargetSite. - public class PatchRequest : DiscoveryEngineBaseServiceRequest + /// Initializes Get parameter list. + protected override void InitParameters() { - /// Constructs a new Patch request. - public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string name) : base(service) - { - Name = name; - Body = body; - InitParameters(); - } - - /// - /// Output only. The fully qualified resource name of the target site. - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` - /// The `target_site_id` is system-generated. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } - - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite Body { get; set; } - - /// Returns the body of the request. - protected override object GetBody() => Body; - - /// Gets the method name. - public override string MethodName => "patch"; - - /// Gets the HTTP method. - public override string HttpMethod => "PATCH"; - - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; - - /// Initializes Patch parameter list. - protected override void InitParameters() + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", - }); - } + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + }); } } - /// Downgrade from advanced site search to basic site search. - /// The body of the request. - /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. + /// Lists all Sessions by their parent DataStore. + /// + /// Required. The data store resource name. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` /// - public virtual DisableAdvancedSiteSearchRequest DisableAdvancedSiteSearch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest body, string siteSearchEngine) + public virtual ListRequest List(string parent) { - return new DisableAdvancedSiteSearchRequest(this.service, body, siteSearchEngine); + return new ListRequest(this.service, parent); } - /// Downgrade from advanced site search to basic site search. - public class DisableAdvancedSiteSearchRequest : DiscoveryEngineBaseServiceRequest + /// Lists all Sessions by their parent DataStore. + public class ListRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new DisableAdvancedSiteSearch request. - public DisableAdvancedSiteSearchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest body, string siteSearchEngine) : base(service) + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) { - SiteSearchEngine = siteSearchEngine; - Body = body; + Parent = parent; InitParameters(); } /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. + /// Required. The data store resource name. Format: + /// `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` /// - [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] - public virtual string SiteSearchEngine { get; private set; } + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest Body { get; set; } + /// + /// A filter to apply on the list results. The supported features are: user_pseudo_id, state. + /// Example: "user_pseudo_id = some_id" + /// + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// + /// A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a + /// field name for descending. Supported fields: * `update_time` * `create_time` * + /// `session_name` Example: "update_time desc" "create_time" + /// + [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)] + public virtual string OrderBy { get; set; } + + /// + /// Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is + /// 1000. + /// + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } + + /// + /// A page token, received from a previous `ListSessions` call. Provide this to retrieve the + /// subsequent page. + /// + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } /// Gets the method name. - public override string MethodName => "disableAdvancedSiteSearch"; + public override string MethodName => "list"; /// Gets the HTTP method. - public override string HttpMethod => "POST"; + public override string HttpMethod => "GET"; /// Gets the REST path. - public override string RestPath => "v1/{+siteSearchEngine}:disableAdvancedSiteSearch"; + public override string RestPath => "v1/{+parent}/sessions"; - /// Initializes DisableAdvancedSiteSearch parameter list. + /// Initializes List parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter { - Name = "siteSearchEngine", + Name = "parent", IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", }); - } - } - - /// Upgrade from basic site search to advanced site search. - /// The body of the request. - /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. - /// - public virtual EnableAdvancedSiteSearchRequest EnableAdvancedSiteSearch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest body, string siteSearchEngine) - { - return new EnableAdvancedSiteSearchRequest(this.service, body, siteSearchEngine); - } - - /// Upgrade from basic site search to advanced site search. - public class EnableAdvancedSiteSearchRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new EnableAdvancedSiteSearch request. - public EnableAdvancedSiteSearchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest body, string siteSearchEngine) : base(service) - { - SiteSearchEngine = siteSearchEngine; - Body = body; - InitParameters(); - } - - /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. - /// - [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] - public virtual string SiteSearchEngine { get; private set; } - - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest Body { get; set; } - - /// Returns the body of the request. - protected override object GetBody() => Body; - - /// Gets the method name. - public override string MethodName => "enableAdvancedSiteSearch"; - - /// Gets the HTTP method. - public override string HttpMethod => "POST"; - - /// Gets the REST path. - public override string RestPath => "v1/{+siteSearchEngine}:enableAdvancedSiteSearch"; - - /// Initializes EnableAdvancedSiteSearch parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter { - Name = "siteSearchEngine", - IsRequired = true, - ParameterType = "path", + Name = "filter", + IsRequired = false, + ParameterType = "query", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + Pattern = null, + }); + RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter + { + Name = "orderBy", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, }); } } - /// Request on-demand recrawl for a list of URIs. + /// + /// Updates a Session. Session action type cannot be changed. If the Session to update does not + /// exist, a NOT_FOUND error is returned. + /// /// The body of the request. - /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. + /// + /// Immutable. Fully qualified name + /// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` /// - public virtual RecrawlUrisRequest RecrawlUris(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest body, string siteSearchEngine) + public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string name) { - return new RecrawlUrisRequest(this.service, body, siteSearchEngine); + return new PatchRequest(this.service, body, name); } - /// Request on-demand recrawl for a list of URIs. - public class RecrawlUrisRequest : DiscoveryEngineBaseServiceRequest + /// + /// Updates a Session. Session action type cannot be changed. If the Session to update does not + /// exist, a NOT_FOUND error is returned. + /// + public class PatchRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new RecrawlUris request. - public RecrawlUrisRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest body, string siteSearchEngine) : base(service) + /// Constructs a new Patch request. + public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session body, string name) : base(service) { - SiteSearchEngine = siteSearchEngine; + Name = name; Body = body; InitParameters(); } /// - /// Required. Full resource name of the SiteSearchEngine, such as - /// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. + /// Immutable. Fully qualified name + /// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` /// - [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] - public virtual string SiteSearchEngine { get; private set; } + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// + /// Indicates which fields in the provided Session to update. The following are NOT supported: * + /// Session.name If not set or empty, all supported fields are updated. + /// + [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] + public virtual object UpdateMask { get; set; } /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest Body { get; set; } + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1Session Body { get; set; } /// Returns the body of the request. protected override object GetBody() => Body; /// Gets the method name. - public override string MethodName => "recrawlUris"; + public override string MethodName => "patch"; /// Gets the HTTP method. - public override string HttpMethod => "POST"; + public override string HttpMethod => "PATCH"; /// Gets the REST path. - public override string RestPath => "v1/{+siteSearchEngine}:recrawlUris"; + public override string RestPath => "v1/{+name}"; - /// Initializes RecrawlUris parameter list. + /// Initializes Patch parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter { - Name = "siteSearchEngine", + Name = "name", IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", + }); + RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter + { + Name = "updateMask", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, }); } } } - /// Gets the SuggestionDenyListEntries resource. - public virtual SuggestionDenyListEntriesResource SuggestionDenyListEntries { get; } + /// Gets the SiteSearchEngine resource. + public virtual SiteSearchEngineResource SiteSearchEngine { get; } - /// The "suggestionDenyListEntries" collection of methods. - public class SuggestionDenyListEntriesResource + /// The "siteSearchEngine" collection of methods. + public class SiteSearchEngineResource { - private const string Resource = "suggestionDenyListEntries"; + private const string Resource = "siteSearchEngine"; /// The service which this resource belongs to. private readonly Google.Apis.Services.IClientService service; /// Constructs a new resource. - public SuggestionDenyListEntriesResource(Google.Apis.Services.IClientService service) + public SiteSearchEngineResource(Google.Apis.Services.IClientService service) { this.service = service; + TargetSites = new TargetSitesResource(service); } - /// Imports all SuggestionDenyListEntry for a DataStore. - /// The body of the request. - /// - /// Required. The parent data store resource name for which to import denylist entries. Follows - /// pattern projects/*/locations/*/collections/*/dataStores/*. - /// - public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest body, string parent) - { - return new ImportRequest(this.service, body, parent); - } + /// Gets the TargetSites resource. + public virtual TargetSitesResource TargetSites { get; } - /// Imports all SuggestionDenyListEntry for a DataStore. - public class ImportRequest : DiscoveryEngineBaseServiceRequest + /// The "targetSites" collection of methods. + public class TargetSitesResource { - /// Constructs a new Import request. - public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest body, string parent) : base(service) + private const string Resource = "targetSites"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public TargetSitesResource(Google.Apis.Services.IClientService service) { - Parent = parent; - Body = body; - InitParameters(); + this.service = service; } - /// - /// Required. The parent data store resource name for which to import denylist entries. Follows - /// pattern projects/*/locations/*/collections/*/dataStores/*. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// Creates TargetSite in a batch. + /// The body of the request. + /// + /// Required. The parent resource shared by all TargetSites being created. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// The parent field in the CreateBookRequest messages must either be empty or match this field. + /// + public virtual BatchCreateRequest BatchCreate(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest body, string parent) + { + return new BatchCreateRequest(this.service, body, parent); + } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest Body { get; set; } + /// Creates TargetSite in a batch. + public class BatchCreateRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new BatchCreate request. + public BatchCreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// + /// Required. The parent resource shared by all TargetSites being created. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// The parent field in the CreateBookRequest messages must either be empty or match this + /// field. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Gets the method name. - public override string MethodName => "import"; + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest Body { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/suggestionDenyListEntries:import"; + /// Gets the method name. + public override string MethodName => "batchCreate"; - /// Initializes Import parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/targetSites:batchCreate"; + + /// Initializes BatchCreate parameter list. + protected override void InitParameters() { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", - }); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + }); + } } - } - /// Permanently deletes all SuggestionDenyListEntry for a DataStore. - /// The body of the request. - /// - /// Required. The parent data store resource name for which to import denylist entries. Follows - /// pattern projects/*/locations/*/collections/*/dataStores/*. - /// - public virtual PurgeRequest Purge(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest body, string parent) - { - return new PurgeRequest(this.service, body, parent); - } - - /// Permanently deletes all SuggestionDenyListEntry for a DataStore. - public class PurgeRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Purge request. - public PurgeRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest body, string parent) : base(service) + /// Creates a TargetSite. + /// The body of the request. + /// + /// Required. Parent resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// + public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string parent) { - Parent = parent; - Body = body; - InitParameters(); + return new CreateRequest(this.service, body, parent); } - /// - /// Required. The parent data store resource name for which to import denylist entries. Follows - /// pattern projects/*/locations/*/collections/*/dataStores/*. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// Creates a TargetSite. + public class CreateRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Create request. + public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest Body { get; set; } + /// + /// Required. Parent resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite Body { get; set; } - /// Gets the method name. - public override string MethodName => "purge"; + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the method name. + public override string MethodName => "create"; - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/suggestionDenyListEntries:purge"; + /// Gets the HTTP method. + public override string HttpMethod => "POST"; - /// Initializes Purge parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/targetSites"; + + /// Initializes Create parameter list. + protected override void InitParameters() { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/.*$", - }); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + }); + } } - } - } - /// Gets the UserEvents resource. - public virtual UserEventsResource UserEvents { get; } + /// Deletes a TargetSite. + /// + /// Required. Full resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. + /// If the caller does not have permission to access the TargetSite, regardless of whether or + /// not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not + /// exist, a NOT_FOUND error is returned. + /// + public virtual DeleteRequest Delete(string name) + { + return new DeleteRequest(this.service, name); + } - /// The "userEvents" collection of methods. - public class UserEventsResource - { - private const string Resource = "userEvents"; + /// Deletes a TargetSite. + public class DeleteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Delete request. + public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + /// + /// Required. Full resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. + /// If the caller does not have permission to access the TargetSite, regardless of whether + /// or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite + /// does not exist, a NOT_FOUND error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Constructs a new resource. - public UserEventsResource(Google.Apis.Services.IClientService service) - { - this.service = service; - } + /// Gets the method name. + public override string MethodName => "delete"; - /// - /// Writes a single user event from the browser. This uses a GET request to due to browser - /// restriction of POST-ing to a third-party domain. This method is used only by the Discovery - /// Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. - /// - /// - /// Required. The parent DataStore resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. - /// - public virtual CollectRequest Collect(string parent) - { - return new CollectRequest(this.service, parent); - } + /// Gets the HTTP method. + public override string HttpMethod => "DELETE"; - /// - /// Writes a single user event from the browser. This uses a GET request to due to browser - /// restriction of POST-ing to a third-party domain. This method is used only by the Discovery - /// Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. - /// - public class CollectRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Collect request. - public CollectRequest(Google.Apis.Services.IClientService service, string parent) : base(service) - { - Parent = parent; - InitParameters(); - } + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// - /// Required. The parent DataStore resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// Initializes Delete parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", + }); + } + } - /// - /// The event timestamp in milliseconds. This prevents browser caching of otherwise identical - /// get requests. The name is abbreviated to reduce the payload bytes. - /// - [Google.Apis.Util.RequestParameterAttribute("ets", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable Ets { get; set; } + /// Gets a TargetSite. + /// + /// Required. Full resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. + /// If the caller does not have permission to access the TargetSite, regardless of whether or + /// not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not + /// exist, a NOT_FOUND error is returned. + /// + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } - /// - /// The URL including cgi-parameters but excluding the hash fragment with a length limit of - /// 5,000 characters. This is often more useful than the referer URL, because many browsers only - /// send the domain for third-party requests. - /// - [Google.Apis.Util.RequestParameterAttribute("uri", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Uri { get; set; } + /// Gets a TargetSite. + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } - /// - /// Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - /// - [Google.Apis.Util.RequestParameterAttribute("userEvent", Google.Apis.Util.RequestParameterType.Query)] - public virtual string UserEvent { get; set; } + /// + /// Required. Full resource name of TargetSite, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. + /// If the caller does not have permission to access the TargetSite, regardless of whether + /// or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite + /// does not exist, a NOT_FOUND error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } - /// Gets the method name. - public override string MethodName => "collect"; + /// Gets the method name. + public override string MethodName => "get"; - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Gets the HTTP method. + public override string HttpMethod => "GET"; - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/userEvents:collect"; + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; - /// Initializes Collect parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + /// Initializes Get parameter list. + protected override void InitParameters() { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", - }); - RequestParameters.Add("ets", new Google.Apis.Discovery.Parameter + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", + }); + } + } + + /// Gets a list of TargetSites. + /// + /// Required. The parent site search engine resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// If the caller does not have permission to list TargetSites under this site search engine, + /// regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + /// + public virtual ListRequest List(string parent) + { + return new ListRequest(this.service, parent); + } + + /// Gets a list of TargetSites. + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) { - Name = "ets", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("uri", new Google.Apis.Discovery.Parameter + Parent = parent; + InitParameters(); + } + + /// + /// Required. The parent site search engine resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// If the caller does not have permission to list TargetSites under this site search + /// engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is + /// returned. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// + /// Requested page size. Server may return fewer items than requested. If unspecified, + /// server will pick an appropriate default. The maximum value is 1000; values above 1000 + /// will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is + /// returned. + /// + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } + + /// + /// A page token, received from a previous `ListTargetSites` call. Provide this to retrieve + /// the subsequent page. When paginating, all other parameters provided to `ListTargetSites` + /// must match the call that provided the page token. + /// + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } + + /// Gets the method name. + public override string MethodName => "list"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/targetSites"; + + /// Initializes List parameter list. + protected override void InitParameters() { - Name = "uri", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("userEvent", new Google.Apis.Discovery.Parameter + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + + /// Updates a TargetSite. + /// The body of the request. + /// + /// Output only. The fully qualified resource name of the target site. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` + /// The `target_site_id` is system-generated. + /// + public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string name) + { + return new PatchRequest(this.service, body, name); + } + + /// Updates a TargetSite. + public class PatchRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Patch request. + public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite body, string name) : base(service) { - Name = "userEvent", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); + Name = name; + Body = body; + InitParameters(); + } + + /// + /// Output only. The fully qualified resource name of the target site. + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` + /// The `target_site_id` is system-generated. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1TargetSite Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "patch"; + + /// Gets the HTTP method. + public override string HttpMethod => "PATCH"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Patch parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", + }); + } } } - /// - /// Bulk import of User events. Request processing might be synchronous. Events that already exist - /// are skipped. Use this method for backfilling historical user events. Operation.response is of - /// type ImportResponse. Note that it is possible for a subset of the items to be successfully - /// inserted. Operation.metadata is of type ImportMetadata. - /// + /// Downgrade from advanced site search to basic site search. /// The body of the request. - /// - /// Required. Parent DataStore resource name, of the form - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` + /// + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. /// - public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest body, string parent) + public virtual DisableAdvancedSiteSearchRequest DisableAdvancedSiteSearch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest body, string siteSearchEngine) { - return new ImportRequest(this.service, body, parent); + return new DisableAdvancedSiteSearchRequest(this.service, body, siteSearchEngine); } - /// - /// Bulk import of User events. Request processing might be synchronous. Events that already exist - /// are skipped. Use this method for backfilling historical user events. Operation.response is of - /// type ImportResponse. Note that it is possible for a subset of the items to be successfully - /// inserted. Operation.metadata is of type ImportMetadata. - /// - public class ImportRequest : DiscoveryEngineBaseServiceRequest + /// Downgrade from advanced site search to basic site search. + public class DisableAdvancedSiteSearchRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Import request. - public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest body, string parent) : base(service) + /// Constructs a new DisableAdvancedSiteSearch request. + public DisableAdvancedSiteSearchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest body, string siteSearchEngine) : base(service) { - Parent = parent; + SiteSearchEngine = siteSearchEngine; Body = body; InitParameters(); } /// - /// Required. Parent DataStore resource name, of the form - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] + public virtual string SiteSearchEngine { get; private set; } /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest Body { get; set; } + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest Body { get; set; } /// Returns the body of the request. protected override object GetBody() => Body; /// Gets the method name. - public override string MethodName => "import"; + public override string MethodName => "disableAdvancedSiteSearch"; /// Gets the HTTP method. public override string HttpMethod => "POST"; /// Gets the REST path. - public override string RestPath => "v1/{+parent}/userEvents:import"; + public override string RestPath => "v1/{+siteSearchEngine}:disableAdvancedSiteSearch"; - /// Initializes Import parameter list. + /// Initializes DisableAdvancedSiteSearch parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter { - Name = "parent", + Name = "siteSearchEngine", IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", }); } } - /// Writes a single user event. + /// Upgrade from basic site search to advanced site search. /// The body of the request. - /// - /// Required. The parent resource name. If the write user event action is applied in DataStore - /// level, the format is: - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If - /// the write user event action is applied in Location level, for example, the event with Document - /// across multiple DataStore, the format is: `projects/{project}/locations/{location}`. + /// + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. /// - public virtual WriteRequest Write(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) + public virtual EnableAdvancedSiteSearchRequest EnableAdvancedSiteSearch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest body, string siteSearchEngine) { - return new WriteRequest(this.service, body, parent); + return new EnableAdvancedSiteSearchRequest(this.service, body, siteSearchEngine); } - /// Writes a single user event. - public class WriteRequest : DiscoveryEngineBaseServiceRequest + /// Upgrade from basic site search to advanced site search. + public class EnableAdvancedSiteSearchRequest : DiscoveryEngineBaseServiceRequest { - /// Constructs a new Write request. - public WriteRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) : base(service) + /// Constructs a new EnableAdvancedSiteSearch request. + public EnableAdvancedSiteSearchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest body, string siteSearchEngine) : base(service) { - Parent = parent; + SiteSearchEngine = siteSearchEngine; Body = body; InitParameters(); } /// - /// Required. The parent resource name. If the write user event action is applied in DataStore - /// level, the format is: - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. - /// If the write user event action is applied in Location level, for example, the event with - /// Document across multiple DataStore, the format is: - /// `projects/{project}/locations/{location}`. + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] + public virtual string SiteSearchEngine { get; private set; } /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent Body { get; set; } + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest Body { get; set; } /// Returns the body of the request. protected override object GetBody() => Body; /// Gets the method name. - public override string MethodName => "write"; + public override string MethodName => "enableAdvancedSiteSearch"; /// Gets the HTTP method. public override string HttpMethod => "POST"; /// Gets the REST path. - public override string RestPath => "v1/{+parent}/userEvents:write"; + public override string RestPath => "v1/{+siteSearchEngine}:enableAdvancedSiteSearch"; - /// Initializes Write parameter list. + /// Initializes EnableAdvancedSiteSearch parameter list. protected override void InitParameters() { base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter { - Name = "parent", + Name = "siteSearchEngine", IsRequired = true, ParameterType = "path", DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", }); } } - } - - /// Completes the specified user input with keyword suggestions. - /// - /// Required. The parent data store resource name for which the completion is performed, such as - /// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. - /// - public virtual CompleteQueryRequest CompleteQuery(string dataStore) - { - return new CompleteQueryRequest(this.service, dataStore); - } - /// Completes the specified user input with keyword suggestions. - public class CompleteQueryRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new CompleteQuery request. - public CompleteQueryRequest(Google.Apis.Services.IClientService service, string dataStore) : base(service) + /// Request on-demand recrawl for a list of URIs. + /// The body of the request. + /// + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. + /// + public virtual RecrawlUrisRequest RecrawlUris(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest body, string siteSearchEngine) { - DataStore = dataStore; - InitParameters(); + return new RecrawlUrisRequest(this.service, body, siteSearchEngine); } - /// - /// Required. The parent data store resource name for which the completion is performed, such as - /// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. - /// - [Google.Apis.Util.RequestParameterAttribute("dataStore", Google.Apis.Util.RequestParameterType.Path)] - public virtual string DataStore { get; private set; } - - /// - /// Indicates if tail suggestions should be returned if there are no suggestions that match the full - /// query. Even if set to true, if there are suggestions that match the full query, those are - /// returned and no tail suggestions are returned. - /// - [Google.Apis.Util.RequestParameterAttribute("includeTailSuggestions", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable IncludeTailSuggestions { get; set; } + /// Request on-demand recrawl for a list of URIs. + public class RecrawlUrisRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new RecrawlUris request. + public RecrawlUrisRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest body, string siteSearchEngine) : base(service) + { + SiteSearchEngine = siteSearchEngine; + Body = body; + InitParameters(); + } - /// - /// Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - /// - [Google.Apis.Util.RequestParameterAttribute("query", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Query { get; set; } + /// + /// Required. Full resource name of the SiteSearchEngine, such as + /// `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. + /// + [Google.Apis.Util.RequestParameterAttribute("siteSearchEngine", Google.Apis.Util.RequestParameterType.Path)] + public virtual string SiteSearchEngine { get; private set; } - /// - /// Specifies the autocomplete data model. This overrides any model specified in the Configuration - /// > Autocomplete section of the Cloud console. Currently supported values: * `document` - - /// Using suggestions generated from user-imported documents. * `search-history` - Using suggestions - /// generated from the past history of SearchService.Search API calls. Do not use it when there is - /// no traffic for Search API. * `user-event` - Using suggestions generated from user-imported - /// search events. * `document-completable` - Using suggestions taken directly from user-imported - /// document fields marked as completable. Default values: * `document` is the default model for - /// regular dataStores. * `search-history` is the default model for site search dataStores. - /// - [Google.Apis.Util.RequestParameterAttribute("queryModel", Google.Apis.Util.RequestParameterType.Query)] - public virtual string QueryModel { get; set; } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RecrawlUrisRequest Body { get; set; } - /// - /// A unique identifier for tracking visitors. For example, this could be implemented with an HTTP - /// cookie, which should be able to uniquely identify a visitor on a single device. This unique - /// identifier should not change if the visitor logs in or out of the website. This field should NOT - /// have a fixed value such as `unknown_visitor`. This should be the same identifier as - /// UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded - /// string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is - /// returned. - /// - [Google.Apis.Util.RequestParameterAttribute("userPseudoId", Google.Apis.Util.RequestParameterType.Query)] - public virtual string UserPseudoId { get; set; } + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the method name. - public override string MethodName => "completeQuery"; + /// Gets the method name. + public override string MethodName => "recrawlUris"; - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Gets the HTTP method. + public override string HttpMethod => "POST"; - /// Gets the REST path. - public override string RestPath => "v1/{+dataStore}:completeQuery"; + /// Gets the REST path. + public override string RestPath => "v1/{+siteSearchEngine}:recrawlUris"; - /// Initializes CompleteQuery parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("dataStore", new Google.Apis.Discovery.Parameter - { - Name = "dataStore", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", - }); - RequestParameters.Add("includeTailSuggestions", new Google.Apis.Discovery.Parameter - { - Name = "includeTailSuggestions", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("query", new Google.Apis.Discovery.Parameter - { - Name = "query", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("queryModel", new Google.Apis.Discovery.Parameter - { - Name = "queryModel", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("userPseudoId", new Google.Apis.Discovery.Parameter + /// Initializes RecrawlUris parameter list. + protected override void InitParameters() { - Name = "userPseudoId", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); + base.InitParameters(); + RequestParameters.Add("siteSearchEngine", new Google.Apis.Discovery.Parameter + { + Name = "siteSearchEngine", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + }); + } } } - /// - /// Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or - /// Recommendation use case, an Engine needs to be created separately. - /// - /// The body of the request. - /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}`. - /// - public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string parent) - { - return new CreateRequest(this.service, body, parent); - } + /// Gets the SuggestionDenyListEntries resource. + public virtual SuggestionDenyListEntriesResource SuggestionDenyListEntries { get; } - /// - /// Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or - /// Recommendation use case, an Engine needs to be created separately. - /// - public class CreateRequest : DiscoveryEngineBaseServiceRequest + /// The "suggestionDenyListEntries" collection of methods. + public class SuggestionDenyListEntriesResource { - /// Constructs a new Create request. - public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string parent) : base(service) + private const string Resource = "suggestionDenyListEntries"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public SuggestionDenyListEntriesResource(Google.Apis.Services.IClientService service) { - Parent = parent; - Body = body; - InitParameters(); + this.service = service; } - /// - /// Required. The parent resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection}`. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// Imports all SuggestionDenyListEntry for a DataStore. + /// The body of the request. + /// + /// Required. The parent data store resource name for which to import denylist entries. Follows + /// pattern projects/*/locations/*/collections/*/dataStores/*. + /// + public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest body, string parent) + { + return new ImportRequest(this.service, body, parent); + } - /// - /// A boolean flag indicating whether user want to directly create an advanced data store for site - /// search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE - /// content_config), this flag will be ignored. - /// - [Google.Apis.Util.RequestParameterAttribute("createAdvancedSiteSearch", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable CreateAdvancedSiteSearch { get; set; } + /// Imports all SuggestionDenyListEntry for a DataStore. + public class ImportRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Import request. + public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } - /// - /// Required. The ID to use for the DataStore, which will become the final component of the - /// DataStore's resource name. This field must conform to - /// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. - /// Otherwise, an INVALID_ARGUMENT error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("dataStoreId", Google.Apis.Util.RequestParameterType.Query)] - public virtual string DataStoreId { get; set; } + /// + /// Required. The parent data store resource name for which to import denylist entries. Follows + /// pattern projects/*/locations/*/collections/*/dataStores/*. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore Body { get; set; } + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest Body { get; set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// Returns the body of the request. + protected override object GetBody() => Body; - /// Gets the method name. - public override string MethodName => "create"; + /// Gets the method name. + public override string MethodName => "import"; - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Gets the HTTP method. + public override string HttpMethod => "POST"; - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/dataStores"; + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/suggestionDenyListEntries:import"; - /// Initializes Create parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + /// Initializes Import parameter list. + protected override void InitParameters() { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+$", - }); - RequestParameters.Add("createAdvancedSiteSearch", new Google.Apis.Discovery.Parameter + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + }); + } + } + + /// Permanently deletes all SuggestionDenyListEntry for a DataStore. + /// The body of the request. + /// + /// Required. The parent data store resource name for which to import denylist entries. Follows + /// pattern projects/*/locations/*/collections/*/dataStores/*. + /// + public virtual PurgeRequest Purge(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest body, string parent) + { + return new PurgeRequest(this.service, body, parent); + } + + /// Permanently deletes all SuggestionDenyListEntry for a DataStore. + public class PurgeRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Purge request. + public PurgeRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest body, string parent) : base(service) { - Name = "createAdvancedSiteSearch", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("dataStoreId", new Google.Apis.Discovery.Parameter + Parent = parent; + Body = body; + InitParameters(); + } + + /// + /// Required. The parent data store resource name for which to import denylist entries. Follows + /// pattern projects/*/locations/*/collections/*/dataStores/*. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "purge"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/suggestionDenyListEntries:purge"; + + /// Initializes Purge parameter list. + protected override void InitParameters() { - Name = "dataStoreId", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/.*$", + }); + } } } - /// Deletes a DataStore. - /// - /// Required. Full resource name of DataStore, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If - /// the caller does not have permission to delete the DataStore, regardless of whether or not it exists, - /// a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error - /// is returned. - /// - public virtual DeleteRequest Delete(string name) - { - return new DeleteRequest(this.service, name); - } + /// Gets the UserEvents resource. + public virtual UserEventsResource UserEvents { get; } - /// Deletes a DataStore. - public class DeleteRequest : DiscoveryEngineBaseServiceRequest + /// The "userEvents" collection of methods. + public class UserEventsResource { - /// Constructs a new Delete request. - public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) + private const string Resource = "userEvents"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public UserEventsResource(Google.Apis.Services.IClientService service) { - Name = name; - InitParameters(); + this.service = service; } /// - /// Required. Full resource name of DataStore, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - /// If the caller does not have permission to delete the DataStore, regardless of whether or not it - /// exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a - /// NOT_FOUND error is returned. + /// Writes a single user event from the browser. This uses a GET request to due to browser + /// restriction of POST-ing to a third-party domain. This method is used only by the Discovery + /// Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// + /// Required. The parent DataStore resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. + /// + public virtual CollectRequest Collect(string parent) + { + return new CollectRequest(this.service, parent); + } + + /// + /// Writes a single user event from the browser. This uses a GET request to due to browser + /// restriction of POST-ing to a third-party domain. This method is used only by the Discovery + /// Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. + /// + public class CollectRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Collect request. + public CollectRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + { + Parent = parent; + InitParameters(); + } + + /// + /// Required. The parent DataStore resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// + /// The event timestamp in milliseconds. This prevents browser caching of otherwise identical + /// get requests. The name is abbreviated to reduce the payload bytes. + /// + [Google.Apis.Util.RequestParameterAttribute("ets", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable Ets { get; set; } + + /// + /// The URL including cgi-parameters but excluding the hash fragment with a length limit of + /// 5,000 characters. This is often more useful than the referer URL, because many browsers only + /// send the domain for third-party requests. + /// + [Google.Apis.Util.RequestParameterAttribute("uri", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Uri { get; set; } + + /// + /// Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + /// + [Google.Apis.Util.RequestParameterAttribute("userEvent", Google.Apis.Util.RequestParameterType.Query)] + public virtual string UserEvent { get; set; } + + /// Gets the method name. + public override string MethodName => "collect"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/userEvents:collect"; + + /// Initializes Collect parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + }); + RequestParameters.Add("ets", new Google.Apis.Discovery.Parameter + { + Name = "ets", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("uri", new Google.Apis.Discovery.Parameter + { + Name = "uri", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("userEvent", new Google.Apis.Discovery.Parameter + { + Name = "userEvent", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + + /// + /// Bulk import of user events. Request processing might be synchronous. Events that already exist + /// are skipped. Use this method for backfilling historical user events. Operation.response is of + /// type ImportResponse. Note that it is possible for a subset of the items to be successfully + /// inserted. Operation.metadata is of type ImportMetadata. + /// + /// The body of the request. + /// + /// Required. Parent DataStore resource name, of the form + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` + /// + public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest body, string parent) + { + return new ImportRequest(this.service, body, parent); + } + + /// + /// Bulk import of user events. Request processing might be synchronous. Events that already exist + /// are skipped. Use this method for backfilling historical user events. Operation.response is of + /// type ImportResponse. Note that it is possible for a subset of the items to be successfully + /// inserted. Operation.metadata is of type ImportMetadata. + /// + public class ImportRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Import request. + public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } + + /// + /// Required. Parent DataStore resource name, of the form + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1ImportUserEventsRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "import"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/userEvents:import"; + + /// Initializes Import parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + }); + } + } + + /// Writes a single user event. + /// The body of the request. + /// + /// Required. The parent resource name. If the write user event action is applied in DataStore + /// level, the format is: + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If + /// the write user event action is applied in Location level, for example, the event with Document + /// across multiple DataStore, the format is: `projects/{project}/locations/{location}`. + /// + public virtual WriteRequest Write(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) + { + return new WriteRequest(this.service, body, parent); + } + + /// Writes a single user event. + public class WriteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Write request. + public WriteRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } + + /// + /// Required. The parent resource name. If the write user event action is applied in DataStore + /// level, the format is: + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. + /// If the write user event action is applied in Location level, for example, the event with + /// Document across multiple DataStore, the format is: + /// `projects/{project}/locations/{location}`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "write"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/userEvents:write"; + + /// Initializes Write parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + }); + } + } + } + + /// Completes the specified user input with keyword suggestions. + /// + /// Required. The parent data store resource name for which the completion is performed, such as + /// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. + /// + public virtual CompleteQueryRequest CompleteQuery(string dataStore) + { + return new CompleteQueryRequest(this.service, dataStore); + } + + /// Completes the specified user input with keyword suggestions. + public class CompleteQueryRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new CompleteQuery request. + public CompleteQueryRequest(Google.Apis.Services.IClientService service, string dataStore) : base(service) + { + DataStore = dataStore; + InitParameters(); + } + + /// + /// Required. The parent data store resource name for which the completion is performed, such as + /// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. + /// + [Google.Apis.Util.RequestParameterAttribute("dataStore", Google.Apis.Util.RequestParameterType.Path)] + public virtual string DataStore { get; private set; } + + /// + /// Indicates if tail suggestions should be returned if there are no suggestions that match the full + /// query. Even if set to true, if there are suggestions that match the full query, those are + /// returned and no tail suggestions are returned. + /// + [Google.Apis.Util.RequestParameterAttribute("includeTailSuggestions", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable IncludeTailSuggestions { get; set; } + + /// + /// Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + /// + [Google.Apis.Util.RequestParameterAttribute("query", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Query { get; set; } + + /// + /// Specifies the autocomplete data model. This overrides any model specified in the Configuration + /// > Autocomplete section of the Cloud console. Currently supported values: * `document` - + /// Using suggestions generated from user-imported documents. * `search-history` - Using suggestions + /// generated from the past history of SearchService.Search API calls. Do not use it when there is + /// no traffic for Search API. * `user-event` - Using suggestions generated from user-imported + /// search events. * `document-completable` - Using suggestions taken directly from user-imported + /// document fields marked as completable. Default values: * `document` is the default model for + /// regular dataStores. * `search-history` is the default model for site search dataStores. + /// + [Google.Apis.Util.RequestParameterAttribute("queryModel", Google.Apis.Util.RequestParameterType.Query)] + public virtual string QueryModel { get; set; } + + /// + /// A unique identifier for tracking visitors. For example, this could be implemented with an HTTP + /// cookie, which should be able to uniquely identify a visitor on a single device. This unique + /// identifier should not change if the visitor logs in or out of the website. This field should NOT + /// have a fixed value such as `unknown_visitor`. This should be the same identifier as + /// UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded + /// string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is + /// returned. + /// + [Google.Apis.Util.RequestParameterAttribute("userPseudoId", Google.Apis.Util.RequestParameterType.Query)] + public virtual string UserPseudoId { get; set; } + + /// Gets the method name. + public override string MethodName => "completeQuery"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+dataStore}:completeQuery"; + + /// Initializes CompleteQuery parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("dataStore", new Google.Apis.Discovery.Parameter + { + Name = "dataStore", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + }); + RequestParameters.Add("includeTailSuggestions", new Google.Apis.Discovery.Parameter + { + Name = "includeTailSuggestions", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("query", new Google.Apis.Discovery.Parameter + { + Name = "query", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("queryModel", new Google.Apis.Discovery.Parameter + { + Name = "queryModel", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("userPseudoId", new Google.Apis.Discovery.Parameter + { + Name = "userPseudoId", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + + /// + /// Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or + /// Recommendation use case, an Engine needs to be created separately. + /// + /// The body of the request. + /// + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}`. + /// + public virtual CreateRequest Create(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string parent) + { + return new CreateRequest(this.service, body, parent); + } + + /// + /// Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or + /// Recommendation use case, an Engine needs to be created separately. + /// + public class CreateRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Create request. + public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } + + /// + /// Required. The parent resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection}`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// + /// A boolean flag indicating whether user want to directly create an advanced data store for site + /// search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE + /// content_config), this flag will be ignored. + /// + [Google.Apis.Util.RequestParameterAttribute("createAdvancedSiteSearch", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable CreateAdvancedSiteSearch { get; set; } + + /// + /// Required. The ID to use for the DataStore, which will become the final component of the + /// DataStore's resource name. This field must conform to + /// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + /// Otherwise, an INVALID_ARGUMENT error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("dataStoreId", Google.Apis.Util.RequestParameterType.Query)] + public virtual string DataStoreId { get; set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "create"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/dataStores"; + + /// Initializes Create parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+$", + }); + RequestParameters.Add("createAdvancedSiteSearch", new Google.Apis.Discovery.Parameter + { + Name = "createAdvancedSiteSearch", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("dataStoreId", new Google.Apis.Discovery.Parameter + { + Name = "dataStoreId", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + + /// Deletes a DataStore. + /// + /// Required. Full resource name of DataStore, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If + /// the caller does not have permission to delete the DataStore, regardless of whether or not it exists, + /// a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error + /// is returned. + /// + public virtual DeleteRequest Delete(string name) + { + return new DeleteRequest(this.service, name); + } + + /// Deletes a DataStore. + public class DeleteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Delete request. + public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// + /// Required. Full resource name of DataStore, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + /// If the caller does not have permission to delete the DataStore, regardless of whether or not it + /// exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a + /// NOT_FOUND error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets the method name. + public override string MethodName => "delete"; + + /// Gets the HTTP method. + public override string HttpMethod => "DELETE"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Delete parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + }); + } + } + + /// Gets a DataStore. + /// + /// Required. Full resource name of DataStore, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If + /// the caller does not have permission to access the DataStore, regardless of whether or not it exists, + /// a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error + /// is returned. + /// + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } + + /// Gets a DataStore. + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// + /// Required. Full resource name of DataStore, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + /// If the caller does not have permission to access the DataStore, regardless of whether or not it + /// exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a + /// NOT_FOUND error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets the method name. + public override string MethodName => "get"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Get parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + }); + } + } + + /// Gets the SiteSearchEngine. + /// + /// Required. Resource name of SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or + /// not it exists, a PERMISSION_DENIED error is returned. + /// + public virtual GetSiteSearchEngineRequest GetSiteSearchEngine(string name) + { + return new GetSiteSearchEngineRequest(this.service, name); + } + + /// Gets the SiteSearchEngine. + public class GetSiteSearchEngineRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new GetSiteSearchEngine request. + public GetSiteSearchEngineRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// + /// Required. Resource name of SiteSearchEngine, such as + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + /// If the caller does not have permission to access the [SiteSearchEngine], regardless of whether + /// or not it exists, a PERMISSION_DENIED error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets the method name. + public override string MethodName => "getSiteSearchEngine"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes GetSiteSearchEngine parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + }); + } + } + + /// Lists all the DataStores associated with the project. + /// + /// Required. The parent branch resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have + /// permission to list DataStores under this location, regardless of whether or not this data store + /// exists, a PERMISSION_DENIED error is returned. + /// + public virtual ListRequest List(string parent) + { + return new ListRequest(this.service, parent); + } + + /// Lists all the DataStores associated with the project. + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) + { + Parent = parent; + InitParameters(); + } + + /// + /// Required. The parent branch resource name, such as + /// `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not + /// have permission to list DataStores under this location, regardless of whether or not this data + /// store exists, a PERMISSION_DENIED error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// + /// Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' + /// + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } + + /// + /// Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed + /// value is 50. Values above 50 will be coerced to 50. If this field is negative, an + /// INVALID_ARGUMENT is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } + + /// + /// A page token ListDataStoresResponse.next_page_token, received from a previous + /// DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When + /// paginating, all other parameters provided to DataStoreService.ListDataStores must match the call + /// that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } + + /// Gets the method name. + public override string MethodName => "list"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/dataStores"; + + /// Initializes List parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+$", + }); + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter + { + Name = "filter", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + + /// Updates a DataStore + /// The body of the request. + /// + /// Immutable. The full resource name of the data store. Format: + /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + /// This field must be a UTF-8 encoded string with a length limit of 1024 characters. + /// + public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string name) + { + return new PatchRequest(this.service, body, name); + } + + /// Updates a DataStore + public class PatchRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Patch request. + public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string name) : base(service) + { + Name = name; + Body = body; + InitParameters(); + } + + /// + /// Immutable. The full resource name of the data store. Format: + /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + /// This field must be a UTF-8 encoded string with a length limit of 1024 characters. + /// + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// + /// Indicates which fields in the provided DataStore to update. If an unsupported or unknown field + /// is provided, an INVALID_ARGUMENT error is returned. + /// + [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] + public virtual object UpdateMask { get; set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "patch"; + + /// Gets the HTTP method. + public override string HttpMethod => "PATCH"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Patch parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + }); + RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter + { + Name = "updateMask", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + } + + /// Gets the GroundingConfigs resource. + public virtual GroundingConfigsResource GroundingConfigs { get; } + + /// The "groundingConfigs" collection of methods. + public class GroundingConfigsResource + { + private const string Resource = "groundingConfigs"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public GroundingConfigsResource(Google.Apis.Services.IClientService service) + { + this.service = service; + } + + /// Performs a grounding check. + /// The body of the request. + /// + /// Required. The resource name of the grounding config, such as + /// `projects/*/locations/global/groundingConfigs/default_grounding_config`. + /// + public virtual CheckRequest Check(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1CheckGroundingRequest body, string groundingConfig) + { + return new CheckRequest(this.service, body, groundingConfig); + } + + /// Performs a grounding check. + public class CheckRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Check request. + public CheckRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1CheckGroundingRequest body, string groundingConfig) : base(service) + { + GroundingConfig = groundingConfig; + Body = body; + InitParameters(); + } + + /// + /// Required. The resource name of the grounding config, such as + /// `projects/*/locations/global/groundingConfigs/default_grounding_config`. + /// + [Google.Apis.Util.RequestParameterAttribute("groundingConfig", Google.Apis.Util.RequestParameterType.Path)] + public virtual string GroundingConfig { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1CheckGroundingRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "check"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+groundingConfig}:check"; + + /// Initializes Check parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("groundingConfig", new Google.Apis.Discovery.Parameter + { + Name = "groundingConfig", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/groundingConfigs/[^/]+$", + }); + } + } + } + + /// Gets the Operations resource. + public virtual OperationsResource Operations { get; } + + /// The "operations" collection of methods. + public class OperationsResource + { + private const string Resource = "operations"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public OperationsResource(Google.Apis.Services.IClientService service) + { + this.service = service; + } + + /// + /// 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. + /// + /// The name of the operation resource. + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } + + /// + /// 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. + /// + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// The name of the operation resource. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets the method name. + public override string MethodName => "get"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Get parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + }); + } + } + + /// + /// Lists operations that match the specified filter in the request. If the server doesn't support this + /// method, it returns `UNIMPLEMENTED`. + /// + /// The name of the operation's parent resource. + public virtual ListRequest List(string name) + { + return new ListRequest(this.service, name); + } + + /// + /// Lists operations that match the specified filter in the request. If the server doesn't support this + /// method, it returns `UNIMPLEMENTED`. + /// + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// The name of the operation's parent resource. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// The standard list filter. + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } + + /// The standard list page size. + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } + + /// The standard list page token. + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } + + /// Gets the method name. + public override string MethodName => "list"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}/operations"; + + /// Initializes List parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+$", + }); + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter + { + Name = "filter", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + } + + /// Gets the RankingConfigs resource. + public virtual RankingConfigsResource RankingConfigs { get; } + + /// The "rankingConfigs" collection of methods. + public class RankingConfigsResource + { + private const string Resource = "rankingConfigs"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public RankingConfigsResource(Google.Apis.Services.IClientService service) + { + this.service = service; + } + + /// Ranks a list of text records based on the given input query. + /// The body of the request. + /// + /// Required. The resource name of the rank service config, such as + /// `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. + /// + public virtual RankRequest Rank(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RankRequest body, string rankingConfig) + { + return new RankRequest(this.service, body, rankingConfig); + } + + /// Ranks a list of text records based on the given input query. + public class RankRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Rank request. + public RankRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RankRequest body, string rankingConfig) : base(service) + { + RankingConfig = rankingConfig; + Body = body; + InitParameters(); + } + + /// + /// Required. The resource name of the rank service config, such as + /// `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. + /// + [Google.Apis.Util.RequestParameterAttribute("rankingConfig", Google.Apis.Util.RequestParameterType.Path)] + public virtual string RankingConfig { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1RankRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "rank"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+rankingConfig}:rank"; + + /// Initializes Rank parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("rankingConfig", new Google.Apis.Discovery.Parameter + { + Name = "rankingConfig", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+/rankingConfigs/[^/]+$", + }); + } + } + } + + /// Gets the UserEvents resource. + public virtual UserEventsResource UserEvents { get; } + + /// The "userEvents" collection of methods. + public class UserEventsResource + { + private const string Resource = "userEvents"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public UserEventsResource(Google.Apis.Services.IClientService service) + { + this.service = service; + } + + /// Writes a single user event. + /// The body of the request. + /// + /// Required. The parent resource name. If the write user event action is applied in DataStore level, + /// the format is: + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the + /// write user event action is applied in Location level, for example, the event with Document across + /// multiple DataStore, the format is: `projects/{project}/locations/{location}`. + /// + public virtual WriteRequest Write(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) + { + return new WriteRequest(this.service, body, parent); + } + + /// Writes a single user event. + public class WriteRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Write request. + public WriteRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) : base(service) + { + Parent = parent; + Body = body; + InitParameters(); + } + + /// + /// Required. The parent resource name. If the write user event action is applied in DataStore + /// level, the format is: + /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If + /// the write user event action is applied in Location level, for example, the event with Document + /// across multiple DataStore, the format is: `projects/{project}/locations/{location}`. + /// + [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Parent { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "write"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+parent}/userEvents:write"; + + /// Initializes Write parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter + { + Name = "parent", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/locations/[^/]+$", + }); + } + } + } + } + + /// Gets the Operations resource. + public virtual OperationsResource Operations { get; } + + /// The "operations" collection of methods. + public class OperationsResource + { + private const string Resource = "operations"; + + /// The service which this resource belongs to. + private readonly Google.Apis.Services.IClientService service; + + /// Constructs a new resource. + public OperationsResource(Google.Apis.Services.IClientService service) + { + this.service = service; + } + + /// + /// 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`. + /// + /// The body of the request. + /// The name of the operation resource to be cancelled. + public virtual CancelRequest Cancel(Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest body, string name) + { + return new CancelRequest(this.service, body, name); + } + + /// + /// 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`. + /// + public class CancelRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Cancel request. + public CancelRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest body, string name) : base(service) + { + Name = name; + Body = body; + InitParameters(); + } + + /// The name of the operation resource to be cancelled. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets or sets the body of this request. + Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest Body { get; set; } + + /// Returns the body of the request. + protected override object GetBody() => Body; + + /// Gets the method name. + public override string MethodName => "cancel"; + + /// Gets the HTTP method. + public override string HttpMethod => "POST"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}:cancel"; + + /// Initializes Cancel parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/operations/[^/]+$", + }); + } + } + + /// + /// 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. + /// + /// The name of the operation resource. + public virtual GetRequest Get(string name) + { + return new GetRequest(this.service, name); + } + + /// + /// 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. + /// + public class GetRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new Get request. + public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// The name of the operation resource. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// Gets the method name. + public override string MethodName => "get"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}"; + + /// Initializes Get parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+/operations/[^/]+$", + }); + } + } + + /// + /// Lists operations that match the specified filter in the request. If the server doesn't support this + /// method, it returns `UNIMPLEMENTED`. + /// + /// The name of the operation's parent resource. + public virtual ListRequest List(string name) + { + return new ListRequest(this.service, name); + } + + /// + /// Lists operations that match the specified filter in the request. If the server doesn't support this + /// method, it returns `UNIMPLEMENTED`. + /// + public class ListRequest : DiscoveryEngineBaseServiceRequest + { + /// Constructs a new List request. + public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) + { + Name = name; + InitParameters(); + } + + /// The name of the operation's parent resource. + [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] + public virtual string Name { get; private set; } + + /// The standard list filter. + [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] + public virtual string Filter { get; set; } + + /// The standard list page size. + [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] + public virtual System.Nullable PageSize { get; set; } + + /// The standard list page token. + [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] + public virtual string PageToken { get; set; } + + /// Gets the method name. + public override string MethodName => "list"; + + /// Gets the HTTP method. + public override string HttpMethod => "GET"; + + /// Gets the REST path. + public override string RestPath => "v1/{+name}/operations"; + + /// Initializes List parameter list. + protected override void InitParameters() + { + base.InitParameters(); + RequestParameters.Add("name", new Google.Apis.Discovery.Parameter + { + Name = "name", + IsRequired = true, + ParameterType = "path", + DefaultValue = null, + Pattern = @"^projects/[^/]+$", + }); + RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter + { + Name = "filter", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter + { + Name = "pageSize", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter + { + Name = "pageToken", + IsRequired = false, + ParameterType = "query", + DefaultValue = null, + Pattern = null, + }); + } + } + } + } +} +namespace Google.Apis.DiscoveryEngine.v1.Data +{ + /// + /// 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. + /// + public class GoogleApiHttpBody : Google.Apis.Requests.IDirectResponseSchema + { + /// The HTTP Content-Type header value specifying the content type of the body. + [Newtonsoft.Json.JsonPropertyAttribute("contentType")] + public virtual string ContentType { get; set; } + + /// The HTTP request/response body as raw binary. + [Newtonsoft.Json.JsonPropertyAttribute("data")] + public virtual string Data { get; set; } + + /// + /// Application specific response metadata. Must be set in the first response for streaming APIs. + /// + [Newtonsoft.Json.JsonPropertyAttribute("extensions")] + public virtual System.Collections.Generic.IList> Extensions { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + + /// A description of the context in which an error occurred. + public class GoogleCloudDiscoveryengineLoggingErrorContext : Google.Apis.Requests.IDirectResponseSchema + { + /// The HTTP request which was processed when the error was triggered. + [Newtonsoft.Json.JsonPropertyAttribute("httpRequest")] + public virtual GoogleCloudDiscoveryengineLoggingHttpRequestContext HttpRequest { get; set; } + + /// + /// The location in the source code where the decision was made to report the error, usually the place where it + /// was logged. + /// + [Newtonsoft.Json.JsonPropertyAttribute("reportLocation")] + public virtual GoogleCloudDiscoveryengineLoggingSourceLocation ReportLocation { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + + /// An error log which is reported to the Error Reporting system. + public class GoogleCloudDiscoveryengineLoggingErrorLog : Google.Apis.Requests.IDirectResponseSchema + { + /// A description of the context in which the error occurred. + [Newtonsoft.Json.JsonPropertyAttribute("context")] + public virtual GoogleCloudDiscoveryengineLoggingErrorContext Context { get; set; } + + /// The error payload that is populated on LRO import APIs. + [Newtonsoft.Json.JsonPropertyAttribute("importPayload")] + public virtual GoogleCloudDiscoveryengineLoggingImportErrorContext ImportPayload { get; set; } + + /// A message describing the error. + [Newtonsoft.Json.JsonPropertyAttribute("message")] + public virtual string Message { get; set; } + + /// + /// The API request payload, represented as a protocol buffer. Most API request types are supported—for example: + /// * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * + /// `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest` + /// + [Newtonsoft.Json.JsonPropertyAttribute("requestPayload")] + public virtual System.Collections.Generic.IDictionary RequestPayload { get; set; } + + /// + /// The API response payload, represented as a protocol buffer. This is used to log some "soft errors", where + /// the response is valid but we consider there are some quality issues like unjoined events. The following API + /// responses are supported, and no PII is included: * + /// `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * + /// `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * + /// `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent` + /// + [Newtonsoft.Json.JsonPropertyAttribute("responsePayload")] + public virtual System.Collections.Generic.IDictionary ResponsePayload { get; set; } + + /// The service context in which this error has occurred. + [Newtonsoft.Json.JsonPropertyAttribute("serviceContext")] + public virtual GoogleCloudDiscoveryengineLoggingServiceContext ServiceContext { get; set; } + + /// The RPC status associated with the error log. + [Newtonsoft.Json.JsonPropertyAttribute("status")] + public virtual GoogleRpcStatus Status { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + + /// HTTP request data that is related to a reported error. + public class GoogleCloudDiscoveryengineLoggingHttpRequestContext : Google.Apis.Requests.IDirectResponseSchema + { + /// The HTTP response status code for the request. + [Newtonsoft.Json.JsonPropertyAttribute("responseStatusCode")] + public virtual System.Nullable ResponseStatusCode { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + + /// + /// The error payload that is populated on LRO import APIs, including the following: * + /// `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * + /// `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents` + /// + public class GoogleCloudDiscoveryengineLoggingImportErrorContext : Google.Apis.Requests.IDirectResponseSchema + { + /// The detailed content which caused the error on importing a document. + [Newtonsoft.Json.JsonPropertyAttribute("document")] + public virtual string Document { get; set; } + + /// + /// Google Cloud Storage file path of the import source. Can be set for batch operation error. + /// + [Newtonsoft.Json.JsonPropertyAttribute("gcsPath")] + public virtual string GcsPath { get; set; } - /// Gets the method name. - public override string MethodName => "delete"; + /// + /// Line number of the content in file. Should be empty for permission or batch operation error. + /// + [Newtonsoft.Json.JsonPropertyAttribute("lineNumber")] + public virtual string LineNumber { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "DELETE"; + /// The operation resource name of the LRO. + [Newtonsoft.Json.JsonPropertyAttribute("operation")] + public virtual string Operation { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// The detailed content which caused the error on importing a user event. + [Newtonsoft.Json.JsonPropertyAttribute("userEvent")] + public virtual string UserEvent { get; set; } - /// Initializes Delete parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", - }); - } - } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Gets a DataStore. - /// - /// Required. Full resource name of DataStore, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If - /// the caller does not have permission to access the DataStore, regardless of whether or not it exists, - /// a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error - /// is returned. - /// - public virtual GetRequest Get(string name) - { - return new GetRequest(this.service, name); - } + /// Describes a running service that sends errors. + public class GoogleCloudDiscoveryengineLoggingServiceContext : Google.Apis.Requests.IDirectResponseSchema + { + /// An identifier of the service—for example, `discoveryengine.googleapis.com`. + [Newtonsoft.Json.JsonPropertyAttribute("service")] + public virtual string Service { get; set; } - /// Gets a DataStore. - public class GetRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// - /// Required. Full resource name of DataStore, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - /// If the caller does not have permission to access the DataStore, regardless of whether or not it - /// exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a - /// NOT_FOUND error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// Indicates a location in the source code of the service for which errors are reported. + public class GoogleCloudDiscoveryengineLoggingSourceLocation : Google.Apis.Requests.IDirectResponseSchema + { + /// + /// Human-readable name of a function or method—for example, + /// `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. + /// + [Newtonsoft.Json.JsonPropertyAttribute("functionName")] + public virtual string FunctionName { get; set; } - /// Gets the method name. - public override string MethodName => "get"; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Defines an answer. + public class GoogleCloudDiscoveryengineV1Answer : Google.Apis.Requests.IDirectResponseSchema + { + /// + /// Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this + /// field is not set. + /// + [Newtonsoft.Json.JsonPropertyAttribute("answerSkippedReasons")] + public virtual System.Collections.Generic.IList AnswerSkippedReasons { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// The textual answer. + [Newtonsoft.Json.JsonPropertyAttribute("answerText")] + public virtual string AnswerText { get; set; } - /// Initializes Get parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", - }); - } - } + /// Citations. + [Newtonsoft.Json.JsonPropertyAttribute("citations")] + public virtual System.Collections.Generic.IList Citations { get; set; } - /// Gets the SiteSearchEngine. - /// - /// Required. Resource name of SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or - /// not it exists, a PERMISSION_DENIED error is returned. - /// - public virtual GetSiteSearchEngineRequest GetSiteSearchEngine(string name) - { - return new GetSiteSearchEngineRequest(this.service, name); - } + private string _completeTimeRaw; - /// Gets the SiteSearchEngine. - public class GetSiteSearchEngineRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new GetSiteSearchEngine request. - public GetSiteSearchEngineRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + private object _completeTime; - /// - /// Required. Resource name of SiteSearchEngine, such as - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. - /// If the caller does not have permission to access the [SiteSearchEngine], regardless of whether - /// or not it exists, a PERMISSION_DENIED error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// Output only. Answer completed timestamp. + [Newtonsoft.Json.JsonPropertyAttribute("completeTime")] + public virtual string CompleteTimeRaw + { + get => _completeTimeRaw; + set + { + _completeTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value); + _completeTimeRaw = value; + } + } - /// Gets the method name. - public override string MethodName => "getSiteSearchEngine"; + /// representation of . + [Newtonsoft.Json.JsonIgnoreAttribute] + [System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use CompleteTimeDateTimeOffset instead.")] + public virtual object CompleteTime + { + get => _completeTime; + set + { + _completeTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value); + _completeTime = value; + } + } - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// representation of . + [Newtonsoft.Json.JsonIgnoreAttribute] + public virtual System.DateTimeOffset? CompleteTimeDateTimeOffset + { + get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(CompleteTimeRaw); + set => CompleteTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value); + } - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + private string _createTimeRaw; - /// Initializes GetSiteSearchEngine parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", - }); - } - } + private object _createTime; - /// Lists all the DataStores associated with the project. - /// - /// Required. The parent branch resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have - /// permission to list DataStores under this location, regardless of whether or not this data store - /// exists, a PERMISSION_DENIED error is returned. - /// - public virtual ListRequest List(string parent) - { - return new ListRequest(this.service, parent); - } + /// Output only. Answer creation timestamp. + [Newtonsoft.Json.JsonPropertyAttribute("createTime")] + public virtual string CreateTimeRaw + { + get => _createTimeRaw; + set + { + _createTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value); + _createTimeRaw = value; + } + } - /// Lists all the DataStores associated with the project. - public class ListRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) - { - Parent = parent; - InitParameters(); - } + /// representation of . + [Newtonsoft.Json.JsonIgnoreAttribute] + [System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")] + public virtual object CreateTime + { + get => _createTime; + set + { + _createTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value); + _createTime = value; + } + } + + /// representation of . + [Newtonsoft.Json.JsonIgnoreAttribute] + public virtual System.DateTimeOffset? CreateTimeDateTimeOffset + { + get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(CreateTimeRaw); + set => CreateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value); + } - /// - /// Required. The parent branch resource name, such as - /// `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not - /// have permission to list DataStores under this location, regardless of whether or not this data - /// store exists, a PERMISSION_DENIED error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// + /// Immutable. Fully qualified name + /// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` + /// + [Newtonsoft.Json.JsonPropertyAttribute("name")] + public virtual string Name { get; set; } - /// - /// Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' - /// - [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Filter { get; set; } + /// Query understanding information. + [Newtonsoft.Json.JsonPropertyAttribute("queryUnderstandingInfo")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo QueryUnderstandingInfo { get; set; } - /// - /// Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed - /// value is 50. Values above 50 will be coerced to 50. If this field is negative, an - /// INVALID_ARGUMENT is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable PageSize { get; set; } + /// References. + [Newtonsoft.Json.JsonPropertyAttribute("references")] + public virtual System.Collections.Generic.IList References { get; set; } - /// - /// A page token ListDataStoresResponse.next_page_token, received from a previous - /// DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When - /// paginating, all other parameters provided to DataStoreService.ListDataStores must match the call - /// that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] - public virtual string PageToken { get; set; } + /// Suggested related questions. + [Newtonsoft.Json.JsonPropertyAttribute("relatedQuestions")] + public virtual System.Collections.Generic.IList RelatedQuestions { get; set; } - /// Gets the method name. - public override string MethodName => "list"; + /// The state of the answer generation. + [Newtonsoft.Json.JsonPropertyAttribute("state")] + public virtual string State { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Answer generation steps. + [Newtonsoft.Json.JsonPropertyAttribute("steps")] + public virtual System.Collections.Generic.IList Steps { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/dataStores"; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Initializes List parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+$", - }); - RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter - { - Name = "filter", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter - { - Name = "pageSize", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter - { - Name = "pageToken", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } - } + /// Citation info for a segment. + public class GoogleCloudDiscoveryengineV1AnswerCitation : Google.Apis.Requests.IDirectResponseSchema + { + /// End of the attributed segment, exclusive. + [Newtonsoft.Json.JsonPropertyAttribute("endIndex")] + public virtual System.Nullable EndIndex { get; set; } - /// Updates a DataStore - /// The body of the request. - /// - /// Immutable. The full resource name of the data store. Format: - /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - /// This field must be a UTF-8 encoded string with a length limit of 1024 characters. - /// - public virtual PatchRequest Patch(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string name) - { - return new PatchRequest(this.service, body, name); - } + /// Citation sources for the attributed segment. + [Newtonsoft.Json.JsonPropertyAttribute("sources")] + public virtual System.Collections.Generic.IList Sources { get; set; } - /// Updates a DataStore - public class PatchRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Patch request. - public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore body, string name) : base(service) - { - Name = name; - Body = body; - InitParameters(); - } + /// Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + [Newtonsoft.Json.JsonPropertyAttribute("startIndex")] + public virtual System.Nullable StartIndex { get; set; } - /// - /// Immutable. The full resource name of the data store. Format: - /// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - /// This field must be a UTF-8 encoded string with a length limit of 1024 characters. - /// - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// - /// Indicates which fields in the provided DataStore to update. If an unsupported or unknown field - /// is provided, an INVALID_ARGUMENT error is returned. - /// - [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] - public virtual object UpdateMask { get; set; } + /// Citation source. + public class GoogleCloudDiscoveryengineV1AnswerCitationSource : Google.Apis.Requests.IDirectResponseSchema + { + /// ID of the citation source. + [Newtonsoft.Json.JsonPropertyAttribute("referenceId")] + public virtual string ReferenceId { get; set; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1DataStore Body { get; set; } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// Request message for ConversationalSearchService.AnswerQuery method. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequest : Google.Apis.Requests.IDirectResponseSchema + { + /// Answer generation specification. + [Newtonsoft.Json.JsonPropertyAttribute("answerGenerationSpec")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec AnswerGenerationSpec { get; set; } - /// Gets the method name. - public override string MethodName => "patch"; + /// + /// Asynchronous mode control. If enabled, the response will be returned with answer/session resource name + /// without final answer. The API users need to do the polling to get the latest status of answer/session by + /// calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. + /// + [Newtonsoft.Json.JsonPropertyAttribute("asynchronousMode")] + public virtual System.Nullable AsynchronousMode { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "PATCH"; + /// Required. Current user query. + [Newtonsoft.Json.JsonPropertyAttribute("query")] + public virtual GoogleCloudDiscoveryengineV1Query Query { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Query understanding specification. + [Newtonsoft.Json.JsonPropertyAttribute("queryUnderstandingSpec")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec QueryUnderstandingSpec { get; set; } - /// Initializes Patch parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", - }); - RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter - { - Name = "updateMask", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } - } - } + /// Related questions specification. + [Newtonsoft.Json.JsonPropertyAttribute("relatedQuestionsSpec")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec RelatedQuestionsSpec { get; set; } - /// Gets the GroundingConfigs resource. - public virtual GroundingConfigsResource GroundingConfigs { get; } + /// Model specification. + [Newtonsoft.Json.JsonPropertyAttribute("safetySpec")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec SafetySpec { get; set; } - /// The "groundingConfigs" collection of methods. - public class GroundingConfigsResource - { - private const string Resource = "groundingConfigs"; + /// Search specification. + [Newtonsoft.Json.JsonPropertyAttribute("searchSpec")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec SearchSpec { get; set; } - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + /// + /// The session resource name. Not required. When session field is not set, the API is in sessionless mode. We + /// support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be + /// automatically generated and assigned. + /// + [Newtonsoft.Json.JsonPropertyAttribute("session")] + public virtual string Session { get; set; } - /// Constructs a new resource. - public GroundingConfigsResource(Google.Apis.Services.IClientService service) - { - this.service = service; - } + /// + /// A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which + /// should be able to uniquely identify a visitor on a single device. This unique identifier should not change + /// if the visitor logs in or out of the website. This field should NOT have a fixed value such as + /// `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. + /// Otherwise, an `INVALID_ARGUMENT` error is returned. + /// + [Newtonsoft.Json.JsonPropertyAttribute("userPseudoId")] + public virtual string UserPseudoId { get; set; } - /// Performs a grounding check. - /// The body of the request. - /// - /// Required. The resource name of the grounding config, such as - /// `projects/*/locations/global/groundingConfigs/default_grounding_config`. - /// - public virtual CheckRequest Check(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1CheckGroundingRequest body, string groundingConfig) - { - return new CheckRequest(this.service, body, groundingConfig); - } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Performs a grounding check. - public class CheckRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Check request. - public CheckRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1CheckGroundingRequest body, string groundingConfig) : base(service) - { - GroundingConfig = groundingConfig; - Body = body; - InitParameters(); - } + /// Answer generation specification. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec : Google.Apis.Requests.IDirectResponseSchema + { + /// + /// Language code for Answer. Use language tags defined by + /// [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. + /// + [Newtonsoft.Json.JsonPropertyAttribute("answerLanguageCode")] + public virtual string AnswerLanguageCode { get; set; } - /// - /// Required. The resource name of the grounding config, such as - /// `projects/*/locations/global/groundingConfigs/default_grounding_config`. - /// - [Google.Apis.Util.RequestParameterAttribute("groundingConfig", Google.Apis.Util.RequestParameterType.Path)] - public virtual string GroundingConfig { get; private set; } + /// + /// Specifies whether to filter out adversarial queries. The default value is `false`. Google employs + /// search-query classification to detect adversarial queries. No answer is returned if the search query is + /// classified as an adversarial query. For example, a user might ask a question regarding negative comments + /// about the company or submit a query designed to generate unsafe, policy-violating output. If this field is + /// set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. + /// + [Newtonsoft.Json.JsonPropertyAttribute("ignoreAdversarialQuery")] + public virtual System.Nullable IgnoreAdversarialQuery { get; set; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1CheckGroundingRequest Body { get; set; } + /// + /// Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google + /// employs search-query classification to detect answer-seeking queries. No answer is returned if the search + /// query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating + /// answers for non-answer seeking queries and return fallback messages instead. + /// + [Newtonsoft.Json.JsonPropertyAttribute("ignoreNonAnswerSeekingQuery")] + public virtual System.Nullable IgnoreNonAnswerSeekingQuery { get; set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// + /// Specifies whether to include citation metadata in the answer. The default value is `false`. + /// + [Newtonsoft.Json.JsonPropertyAttribute("includeCitations")] + public virtual System.Nullable IncludeCitations { get; set; } - /// Gets the method name. - public override string MethodName => "check"; + /// Answer generation model specification. + [Newtonsoft.Json.JsonPropertyAttribute("modelSpec")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec ModelSpec { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Answer generation prompt specification. + [Newtonsoft.Json.JsonPropertyAttribute("promptSpec")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec PromptSpec { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+groundingConfig}:check"; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Initializes Check parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("groundingConfig", new Google.Apis.Discovery.Parameter - { - Name = "groundingConfig", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/groundingConfigs/[^/]+$", - }); - } - } - } + /// Answer Generation Model specification. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec : Google.Apis.Requests.IDirectResponseSchema + { + /// + /// Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. + /// + [Newtonsoft.Json.JsonPropertyAttribute("modelVersion")] + public virtual string ModelVersion { get; set; } - /// Gets the Operations resource. - public virtual OperationsResource Operations { get; } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// The "operations" collection of methods. - public class OperationsResource - { - private const string Resource = "operations"; + /// Answer generation prompt specification. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec : Google.Apis.Requests.IDirectResponseSchema + { + /// Customized preamble. + [Newtonsoft.Json.JsonPropertyAttribute("preamble")] + public virtual string Preamble { get; set; } - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Constructs a new resource. - public OperationsResource(Google.Apis.Services.IClientService service) - { - this.service = service; - } + /// Query understanding specification. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec : Google.Apis.Requests.IDirectResponseSchema + { + /// Query classification specification. + [Newtonsoft.Json.JsonPropertyAttribute("queryClassificationSpec")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec QueryClassificationSpec { get; set; } - /// - /// 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. - /// - /// The name of the operation resource. - public virtual GetRequest Get(string name) - { - return new GetRequest(this.service, name); - } + /// Query rephraser specification. + [Newtonsoft.Json.JsonPropertyAttribute("queryRephraserSpec")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec QueryRephraserSpec { get; set; } - /// - /// 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. - /// - public class GetRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// The name of the operation resource. - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// Query classification specification. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec : Google.Apis.Requests.IDirectResponseSchema + { + /// Enabled query classification types. + [Newtonsoft.Json.JsonPropertyAttribute("types")] + public virtual System.Collections.Generic.IList Types { get; set; } - /// Gets the method name. - public override string MethodName => "get"; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Query rephraser specification. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec : Google.Apis.Requests.IDirectResponseSchema + { + /// Disable query rephraser. + [Newtonsoft.Json.JsonPropertyAttribute("disable")] + public virtual System.Nullable Disable { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Initializes Get parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - }); - } - } + /// Related questions specification. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec : Google.Apis.Requests.IDirectResponseSchema + { + /// Enable related questions feature if true. + [Newtonsoft.Json.JsonPropertyAttribute("enable")] + public virtual System.Nullable Enable { get; set; } - /// - /// Lists operations that match the specified filter in the request. If the server doesn't support this - /// method, it returns `UNIMPLEMENTED`. - /// - /// The name of the operation's parent resource. - public virtual ListRequest List(string name) - { - return new ListRequest(this.service, name); - } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// - /// Lists operations that match the specified filter in the request. If the server doesn't support this - /// method, it returns `UNIMPLEMENTED`. - /// - public class ListRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + /// Safety specification. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec : Google.Apis.Requests.IDirectResponseSchema + { + /// Enable the safety filtering on the answer response. It is false by default. + [Newtonsoft.Json.JsonPropertyAttribute("enable")] + public virtual System.Nullable Enable { get; set; } - /// The name of the operation's parent resource. - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// The standard list filter. - [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Filter { get; set; } + /// Search specification. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec : Google.Apis.Requests.IDirectResponseSchema + { + /// Search parameters. + [Newtonsoft.Json.JsonPropertyAttribute("searchParams")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams SearchParams { get; set; } - /// The standard list page size. - [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable PageSize { get; set; } + /// Search result list. + [Newtonsoft.Json.JsonPropertyAttribute("searchResultList")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList SearchResultList { get; set; } - /// The standard list page token. - [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] - public virtual string PageToken { get; set; } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Gets the method name. - public override string MethodName => "list"; + /// Search parameters. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams : Google.Apis.Requests.IDirectResponseSchema + { + /// + /// Boost specification to boost certain documents in search results which may affect the answer query response. + /// For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + /// + [Newtonsoft.Json.JsonPropertyAttribute("boostSpec")] + public virtual GoogleCloudDiscoveryengineV1SearchRequestBoostSpec BoostSpec { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// + /// The filter syntax consists of an expression language for constructing a predicate from one or more fields of + /// the documents being filtered. Filter expression is case-sensitive. This will be used to filter search + /// results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is + /// returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in + /// the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media + /// customers might have a field 'name' in their schema. In this case the filter would look like this: filter + /// --> name:'ANY("king kong")' For more information about filtering including syntax and filter + /// operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + /// + [Newtonsoft.Json.JsonPropertyAttribute("filter")] + public virtual string Filter { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}/operations"; + /// Number of search results to return. The default value is 10. + [Newtonsoft.Json.JsonPropertyAttribute("maxReturnResults")] + public virtual System.Nullable MaxReturnResults { get; set; } - /// Initializes List parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+$", - }); - RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter - { - Name = "filter", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter - { - Name = "pageSize", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter - { - Name = "pageToken", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } - } - } + /// + /// The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave + /// it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, + /// see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, + /// an `INVALID_ARGUMENT` is returned. + /// + [Newtonsoft.Json.JsonPropertyAttribute("orderBy")] + public virtual string OrderBy { get; set; } - /// Gets the UserEvents resource. - public virtual UserEventsResource UserEvents { get; } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// The "userEvents" collection of methods. - public class UserEventsResource - { - private const string Resource = "userEvents"; + /// Search result list. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList : Google.Apis.Requests.IDirectResponseSchema + { + /// Search results. + [Newtonsoft.Json.JsonPropertyAttribute("searchResults")] + public virtual System.Collections.Generic.IList SearchResults { get; set; } - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Constructs a new resource. - public UserEventsResource(Google.Apis.Services.IClientService service) - { - this.service = service; - } + /// Search result. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult : Google.Apis.Requests.IDirectResponseSchema + { + /// Chunk information. + [Newtonsoft.Json.JsonPropertyAttribute("chunkInfo")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo ChunkInfo { get; set; } - /// Writes a single user event. - /// The body of the request. - /// - /// Required. The parent resource name. If the write user event action is applied in DataStore level, - /// the format is: - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the - /// write user event action is applied in Location level, for example, the event with Document across - /// multiple DataStore, the format is: `projects/{project}/locations/{location}`. - /// - public virtual WriteRequest Write(Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) - { - return new WriteRequest(this.service, body, parent); - } + /// Unstructured document information. + [Newtonsoft.Json.JsonPropertyAttribute("unstructuredDocumentInfo")] + public virtual GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo UnstructuredDocumentInfo { get; set; } - /// Writes a single user event. - public class WriteRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Write request. - public WriteRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent body, string parent) : base(service) - { - Parent = parent; - Body = body; - InitParameters(); - } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// - /// Required. The parent resource name. If the write user event action is applied in DataStore - /// level, the format is: - /// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If - /// the write user event action is applied in Location level, for example, the event with Document - /// across multiple DataStore, the format is: `projects/{project}/locations/{location}`. - /// - [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Parent { get; private set; } + /// Chunk information. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo : Google.Apis.Requests.IDirectResponseSchema + { + /// Chunk resource name. + [Newtonsoft.Json.JsonPropertyAttribute("chunk")] + public virtual string Chunk { get; set; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleCloudDiscoveryengineV1UserEvent Body { get; set; } + /// Chunk textual content. + [Newtonsoft.Json.JsonPropertyAttribute("content")] + public virtual string Content { get; set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Gets the method name. - public override string MethodName => "write"; + /// Unstructured document information. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo : Google.Apis.Requests.IDirectResponseSchema + { + /// Document resource name. + [Newtonsoft.Json.JsonPropertyAttribute("document")] + public virtual string Document { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// List of document contexts. + [Newtonsoft.Json.JsonPropertyAttribute("documentContexts")] + public virtual System.Collections.Generic.IList DocumentContexts { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+parent}/userEvents:write"; + /// List of extractive answers. + [Newtonsoft.Json.JsonPropertyAttribute("extractiveAnswers")] + public virtual System.Collections.Generic.IList ExtractiveAnswers { get; set; } - /// Initializes Write parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter - { - Name = "parent", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/locations/[^/]+$", - }); - } - } - } - } + /// List of extractive segments. + [Newtonsoft.Json.JsonPropertyAttribute("extractiveSegments")] + public virtual System.Collections.Generic.IList ExtractiveSegments { get; set; } - /// Gets the Operations resource. - public virtual OperationsResource Operations { get; } + /// Title. + [Newtonsoft.Json.JsonPropertyAttribute("title")] + public virtual string Title { get; set; } - /// The "operations" collection of methods. - public class OperationsResource - { - private const string Resource = "operations"; + /// URI for the document. + [Newtonsoft.Json.JsonPropertyAttribute("uri")] + public virtual string Uri { get; set; } - /// The service which this resource belongs to. - private readonly Google.Apis.Services.IClientService service; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Constructs a new resource. - public OperationsResource(Google.Apis.Services.IClientService service) - { - this.service = service; - } + /// Document context. + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext : Google.Apis.Requests.IDirectResponseSchema + { + /// Document content. + [Newtonsoft.Json.JsonPropertyAttribute("content")] + public virtual string Content { get; set; } - /// - /// 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`. - /// - /// The body of the request. - /// The name of the operation resource to be cancelled. - public virtual CancelRequest Cancel(Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest body, string name) - { - return new CancelRequest(this.service, body, name); - } + /// Page identifier. + [Newtonsoft.Json.JsonPropertyAttribute("pageIdentifier")] + public virtual string PageIdentifier { get; set; } - /// - /// 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`. - /// - public class CancelRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Cancel request. - public CancelRequest(Google.Apis.Services.IClientService service, Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest body, string name) : base(service) - { - Name = name; - Body = body; - InitParameters(); - } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// The name of the operation resource to be cancelled. - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// + /// Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers) + /// + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer : Google.Apis.Requests.IDirectResponseSchema + { + /// Extractive answer content. + [Newtonsoft.Json.JsonPropertyAttribute("content")] + public virtual string Content { get; set; } - /// Gets or sets the body of this request. - Google.Apis.DiscoveryEngine.v1.Data.GoogleLongrunningCancelOperationRequest Body { get; set; } + /// Page identifier. + [Newtonsoft.Json.JsonPropertyAttribute("pageIdentifier")] + public virtual string PageIdentifier { get; set; } - /// Returns the body of the request. - protected override object GetBody() => Body; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Gets the method name. - public override string MethodName => "cancel"; + /// + /// Extractive segment. + /// [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + /// + public class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment : Google.Apis.Requests.IDirectResponseSchema + { + /// Extractive segment content. + [Newtonsoft.Json.JsonPropertyAttribute("content")] + public virtual string Content { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "POST"; + /// Page identifier. + [Newtonsoft.Json.JsonPropertyAttribute("pageIdentifier")] + public virtual string PageIdentifier { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}:cancel"; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Initializes Cancel parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/operations/[^/]+$", - }); - } - } + /// Response message for ConversationalSearchService.AnswerQuery method. + public class GoogleCloudDiscoveryengineV1AnswerQueryResponse : Google.Apis.Requests.IDirectResponseSchema + { + /// + /// Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to + /// fetch answer information using ConversationalSearchService.GetAnswer API. + /// + [Newtonsoft.Json.JsonPropertyAttribute("answer")] + public virtual GoogleCloudDiscoveryengineV1Answer Answer { get; set; } - /// - /// 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. - /// - /// The name of the operation resource. - public virtual GetRequest Get(string name) - { - return new GetRequest(this.service, name); - } + /// A global unique ID used for logging. + [Newtonsoft.Json.JsonPropertyAttribute("answerQueryToken")] + public virtual string AnswerQueryToken { get; set; } - /// - /// 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. - /// - public class GetRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new Get request. - public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + /// + /// Session resource object. It will be only available when session field is set and valid in the + /// AnswerQueryRequest request. + /// + [Newtonsoft.Json.JsonPropertyAttribute("session")] + public virtual GoogleCloudDiscoveryengineV1Session Session { get; set; } - /// The name of the operation resource. - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Gets the method name. - public override string MethodName => "get"; + /// Query understanding information. + public class GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo : Google.Apis.Requests.IDirectResponseSchema + { + /// Query classification information. + [Newtonsoft.Json.JsonPropertyAttribute("queryClassificationInfo")] + public virtual System.Collections.Generic.IList QueryClassificationInfo { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Gets the REST path. - public override string RestPath => "v1/{+name}"; + /// Query classification information. + public class GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo : Google.Apis.Requests.IDirectResponseSchema + { + /// Classification output. + [Newtonsoft.Json.JsonPropertyAttribute("positive")] + public virtual System.Nullable Positive { get; set; } - /// Initializes Get parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+/operations/[^/]+$", - }); - } - } + /// Query classification type. + [Newtonsoft.Json.JsonPropertyAttribute("type")] + public virtual string Type { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + + /// Reference. + public class GoogleCloudDiscoveryengineV1AnswerReference : Google.Apis.Requests.IDirectResponseSchema + { + /// Chunk information. + [Newtonsoft.Json.JsonPropertyAttribute("chunkInfo")] + public virtual GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo ChunkInfo { get; set; } + + /// Unstructured document information. + [Newtonsoft.Json.JsonPropertyAttribute("unstructuredDocumentInfo")] + public virtual GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo UnstructuredDocumentInfo { get; set; } - /// - /// Lists operations that match the specified filter in the request. If the server doesn't support this - /// method, it returns `UNIMPLEMENTED`. - /// - /// The name of the operation's parent resource. - public virtual ListRequest List(string name) - { - return new ListRequest(this.service, name); - } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// - /// Lists operations that match the specified filter in the request. If the server doesn't support this - /// method, it returns `UNIMPLEMENTED`. - /// - public class ListRequest : DiscoveryEngineBaseServiceRequest - { - /// Constructs a new List request. - public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service) - { - Name = name; - InitParameters(); - } + /// Chunk information. + public class GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo : Google.Apis.Requests.IDirectResponseSchema + { + /// Chunk resource name. + [Newtonsoft.Json.JsonPropertyAttribute("chunk")] + public virtual string Chunk { get; set; } - /// The name of the operation's parent resource. - [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] - public virtual string Name { get; private set; } + /// Chunk textual content. + [Newtonsoft.Json.JsonPropertyAttribute("content")] + public virtual string Content { get; set; } - /// The standard list filter. - [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] - public virtual string Filter { get; set; } + /// Document metadata. + [Newtonsoft.Json.JsonPropertyAttribute("documentMetadata")] + public virtual GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata DocumentMetadata { get; set; } - /// The standard list page size. - [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable PageSize { get; set; } + /// Relevance score. + [Newtonsoft.Json.JsonPropertyAttribute("relevanceScore")] + public virtual System.Nullable RelevanceScore { get; set; } - /// The standard list page token. - [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] - public virtual string PageToken { get; set; } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// Gets the method name. - public override string MethodName => "list"; + /// Document metadata. + public class GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata : Google.Apis.Requests.IDirectResponseSchema + { + /// Document resource name. + [Newtonsoft.Json.JsonPropertyAttribute("document")] + public virtual string Document { get; set; } - /// Gets the HTTP method. - public override string HttpMethod => "GET"; + /// Page identifier. + [Newtonsoft.Json.JsonPropertyAttribute("pageIdentifier")] + public virtual string PageIdentifier { get; set; } - /// Gets the REST path. - public override string RestPath => "v1/{+name}/operations"; + /// Title. + [Newtonsoft.Json.JsonPropertyAttribute("title")] + public virtual string Title { get; set; } - /// Initializes List parameter list. - protected override void InitParameters() - { - base.InitParameters(); - RequestParameters.Add("name", new Google.Apis.Discovery.Parameter - { - Name = "name", - IsRequired = true, - ParameterType = "path", - DefaultValue = null, - Pattern = @"^projects/[^/]+$", - }); - RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter - { - Name = "filter", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter - { - Name = "pageSize", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter - { - Name = "pageToken", - IsRequired = false, - ParameterType = "query", - DefaultValue = null, - Pattern = null, - }); - } - } - } + /// URI for the document. + [Newtonsoft.Json.JsonPropertyAttribute("uri")] + public virtual string Uri { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } } -} -namespace Google.Apis.DiscoveryEngine.v1.Data -{ - /// - /// 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. - /// - public class GoogleApiHttpBody : Google.Apis.Requests.IDirectResponseSchema + + /// Unstructured document information. + public class GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo : Google.Apis.Requests.IDirectResponseSchema { - /// The HTTP Content-Type header value specifying the content type of the body. - [Newtonsoft.Json.JsonPropertyAttribute("contentType")] - public virtual string ContentType { get; set; } + /// List of cited chunk contents derived from document content. + [Newtonsoft.Json.JsonPropertyAttribute("chunkContents")] + public virtual System.Collections.Generic.IList ChunkContents { get; set; } - /// The HTTP request/response body as raw binary. - [Newtonsoft.Json.JsonPropertyAttribute("data")] - public virtual string Data { get; set; } + /// Document resource name. + [Newtonsoft.Json.JsonPropertyAttribute("document")] + public virtual string Document { get; set; } - /// - /// Application specific response metadata. Must be set in the first response for streaming APIs. - /// - [Newtonsoft.Json.JsonPropertyAttribute("extensions")] - public virtual System.Collections.Generic.IList> Extensions { get; set; } + /// Title. + [Newtonsoft.Json.JsonPropertyAttribute("title")] + public virtual string Title { get; set; } + + /// URI for the document. + [Newtonsoft.Json.JsonPropertyAttribute("uri")] + public virtual string Uri { get; set; } /// The ETag of the item. public virtual string ETag { get; set; } } - /// A description of the context in which an error occurred. - public class GoogleCloudDiscoveryengineLoggingErrorContext : Google.Apis.Requests.IDirectResponseSchema + /// Chunk content. + public class GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent : Google.Apis.Requests.IDirectResponseSchema { - /// The HTTP request which was processed when the error was triggered. - [Newtonsoft.Json.JsonPropertyAttribute("httpRequest")] - public virtual GoogleCloudDiscoveryengineLoggingHttpRequestContext HttpRequest { get; set; } + /// Chunk textual content. + [Newtonsoft.Json.JsonPropertyAttribute("content")] + public virtual string Content { get; set; } - /// - /// The location in the source code where the decision was made to report the error, usually the place where it - /// was logged. - /// - [Newtonsoft.Json.JsonPropertyAttribute("reportLocation")] - public virtual GoogleCloudDiscoveryengineLoggingSourceLocation ReportLocation { get; set; } + /// Page identifier. + [Newtonsoft.Json.JsonPropertyAttribute("pageIdentifier")] + public virtual string PageIdentifier { get; set; } /// The ETag of the item. public virtual string ETag { get; set; } } - /// An error log which is reported to the Error Reporting system. - public class GoogleCloudDiscoveryengineLoggingErrorLog : Google.Apis.Requests.IDirectResponseSchema + /// Step information. + public class GoogleCloudDiscoveryengineV1AnswerStep : Google.Apis.Requests.IDirectResponseSchema { - /// A description of the context in which the error occurred. - [Newtonsoft.Json.JsonPropertyAttribute("context")] - public virtual GoogleCloudDiscoveryengineLoggingErrorContext Context { get; set; } + /// Actions. + [Newtonsoft.Json.JsonPropertyAttribute("actions")] + public virtual System.Collections.Generic.IList Actions { get; set; } - /// The error payload that is populated on LRO import APIs. - [Newtonsoft.Json.JsonPropertyAttribute("importPayload")] - public virtual GoogleCloudDiscoveryengineLoggingImportErrorContext ImportPayload { get; set; } + /// The description of the step. + [Newtonsoft.Json.JsonPropertyAttribute("description")] + public virtual string Description { get; set; } - /// A message describing the error. - [Newtonsoft.Json.JsonPropertyAttribute("message")] - public virtual string Message { get; set; } + /// The state of the step. + [Newtonsoft.Json.JsonPropertyAttribute("state")] + public virtual string State { get; set; } - /// - /// The API request payload, represented as a protocol buffer. Most API request types are supported—for example: - /// * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * - /// `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest` - /// - [Newtonsoft.Json.JsonPropertyAttribute("requestPayload")] - public virtual System.Collections.Generic.IDictionary RequestPayload { get; set; } + /// The thought of the step. + [Newtonsoft.Json.JsonPropertyAttribute("thought")] + public virtual string Thought { get; set; } - /// - /// The API response payload, represented as a protocol buffer. This is used to log some "soft errors", where - /// the response is valid but we consider there are some quality issues like unjoined events. The following API - /// responses are supported, and no PII is included: * - /// `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * - /// `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * - /// `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent` - /// - [Newtonsoft.Json.JsonPropertyAttribute("responsePayload")] - public virtual System.Collections.Generic.IDictionary ResponsePayload { get; set; } + /// The ETag of the item. + public virtual string ETag { get; set; } + } - /// The service context in which this error has occurred. - [Newtonsoft.Json.JsonPropertyAttribute("serviceContext")] - public virtual GoogleCloudDiscoveryengineLoggingServiceContext ServiceContext { get; set; } + /// Action. + public class GoogleCloudDiscoveryengineV1AnswerStepAction : Google.Apis.Requests.IDirectResponseSchema + { + /// Observation. + [Newtonsoft.Json.JsonPropertyAttribute("observation")] + public virtual GoogleCloudDiscoveryengineV1AnswerStepActionObservation Observation { get; set; } - /// The RPC status associated with the error log. - [Newtonsoft.Json.JsonPropertyAttribute("status")] - public virtual GoogleRpcStatus Status { get; set; } + /// Search action. + [Newtonsoft.Json.JsonPropertyAttribute("searchAction")] + public virtual GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction SearchAction { get; set; } /// The ETag of the item. public virtual string ETag { get; set; } } - /// HTTP request data that is related to a reported error. - public class GoogleCloudDiscoveryengineLoggingHttpRequestContext : Google.Apis.Requests.IDirectResponseSchema + /// Observation. + public class GoogleCloudDiscoveryengineV1AnswerStepActionObservation : Google.Apis.Requests.IDirectResponseSchema { - /// The HTTP response status code for the request. - [Newtonsoft.Json.JsonPropertyAttribute("responseStatusCode")] - public virtual System.Nullable ResponseStatusCode { get; set; } + /// + /// Search results observed by the search action, it can be snippets info or chunk info, depending on the + /// citation type set by the user. + /// + [Newtonsoft.Json.JsonPropertyAttribute("searchResults")] + public virtual System.Collections.Generic.IList SearchResults { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + + public class GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult : Google.Apis.Requests.IDirectResponseSchema + { + /// If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. + [Newtonsoft.Json.JsonPropertyAttribute("chunkInfo")] + public virtual System.Collections.Generic.IList ChunkInfo { get; set; } + + /// Document resource name. + [Newtonsoft.Json.JsonPropertyAttribute("document")] + public virtual string Document { get; set; } + + /// If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. + [Newtonsoft.Json.JsonPropertyAttribute("snippetInfo")] + public virtual System.Collections.Generic.IList SnippetInfo { get; set; } + + /// Title. + [Newtonsoft.Json.JsonPropertyAttribute("title")] + public virtual string Title { get; set; } + + /// URI for the document. + [Newtonsoft.Json.JsonPropertyAttribute("uri")] + public virtual string Uri { get; set; } /// The ETag of the item. public virtual string ETag { get; set; } } - /// - /// The error payload that is populated on LRO import APIs, including the following: * - /// `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * - /// `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents` - /// - public class GoogleCloudDiscoveryengineLoggingImportErrorContext : Google.Apis.Requests.IDirectResponseSchema + /// Chunk information. + public class GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo : Google.Apis.Requests.IDirectResponseSchema { - /// The detailed content which caused the error on importing a document. - [Newtonsoft.Json.JsonPropertyAttribute("document")] - public virtual string Document { get; set; } - - /// - /// Google Cloud Storage file path of the import source. Can be set for batch operation error. - /// - [Newtonsoft.Json.JsonPropertyAttribute("gcsPath")] - public virtual string GcsPath { get; set; } - - /// - /// Line number of the content in file. Should be empty for permission or batch operation error. - /// - [Newtonsoft.Json.JsonPropertyAttribute("lineNumber")] - public virtual string LineNumber { get; set; } + /// Chunk resource name. + [Newtonsoft.Json.JsonPropertyAttribute("chunk")] + public virtual string Chunk { get; set; } - /// The operation resource name of the LRO. - [Newtonsoft.Json.JsonPropertyAttribute("operation")] - public virtual string Operation { get; set; } + /// Chunk textual content. + [Newtonsoft.Json.JsonPropertyAttribute("content")] + public virtual string Content { get; set; } - /// The detailed content which caused the error on importing a user event. - [Newtonsoft.Json.JsonPropertyAttribute("userEvent")] - public virtual string UserEvent { get; set; } + /// Relevance score. + [Newtonsoft.Json.JsonPropertyAttribute("relevanceScore")] + public virtual System.Nullable RelevanceScore { get; set; } /// The ETag of the item. public virtual string ETag { get; set; } } - /// Describes a running service that sends errors. - public class GoogleCloudDiscoveryengineLoggingServiceContext : Google.Apis.Requests.IDirectResponseSchema + /// Snippet information. + public class GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo : Google.Apis.Requests.IDirectResponseSchema { - /// An identifier of the service—for example, `discoveryengine.googleapis.com`. - [Newtonsoft.Json.JsonPropertyAttribute("service")] - public virtual string Service { get; set; } + /// Snippet content. + [Newtonsoft.Json.JsonPropertyAttribute("snippet")] + public virtual string Snippet { get; set; } + + /// Status of the snippet defined by the search team. + [Newtonsoft.Json.JsonPropertyAttribute("snippetStatus")] + public virtual string SnippetStatus { get; set; } /// The ETag of the item. public virtual string ETag { get; set; } } - /// Indicates a location in the source code of the service for which errors are reported. - public class GoogleCloudDiscoveryengineLoggingSourceLocation : Google.Apis.Requests.IDirectResponseSchema + /// Search action. + public class GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction : Google.Apis.Requests.IDirectResponseSchema { - /// - /// Human-readable name of a function or method—for example, - /// `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. - /// - [Newtonsoft.Json.JsonPropertyAttribute("functionName")] - public virtual string FunctionName { get; set; } + /// The query to search. + [Newtonsoft.Json.JsonPropertyAttribute("query")] + public virtual string Query { get; set; } /// The ETag of the item. public virtual string ETag { get; set; } @@ -12273,9 +14694,9 @@ public class GoogleCloudDiscoveryengineV1DocumentInfo : Google.Apis.Requests.IDi public virtual System.Collections.Generic.IList PromotionIds { get; set; } /// - /// Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if - /// two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the - /// following event types: * `add-to-cart` * `purchase` + /// Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two + /// quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following + /// event types: * `add-to-cart` * `purchase` /// [Newtonsoft.Json.JsonPropertyAttribute("quantity")] public virtual System.Nullable Quantity { get; set; } @@ -12537,7 +14958,7 @@ public virtual object CreateTime /// /// The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on /// DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore - /// liniked to the engine. + /// linked to the engine. /// [Newtonsoft.Json.JsonPropertyAttribute("industryVertical")] public virtual string IndustryVertical { get; set; } @@ -12789,7 +15210,8 @@ public class GoogleCloudDiscoveryengineV1FhirStoreSource : Google.Apis.Requests. public class GoogleCloudDiscoveryengineV1FirestoreSource : Google.Apis.Requests.IDirectResponseSchema { /// - /// Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. + /// Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 + /// characters. /// [Newtonsoft.Json.JsonPropertyAttribute("collectionId")] public virtual string CollectionId { get; set; } @@ -12831,15 +15253,15 @@ public class GoogleCloudDiscoveryengineV1GcsSource : Google.Apis.Requests.IDirec /// arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC /// Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. /// Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store - /// vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + /// vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. /// [Newtonsoft.Json.JsonPropertyAttribute("dataSchema")] public virtual string DataSchema { get; set; } /// - /// Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full - /// object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such - /// as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if + /// Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the + /// full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, + /// such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if /// `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). /// [Newtonsoft.Json.JsonPropertyAttribute("inputUris")] @@ -13492,6 +15914,21 @@ public class GoogleCloudDiscoveryengineV1ListSchemasResponse : Google.Apis.Reque public virtual string ETag { get; set; } } + /// Response for ListSessions method. + public class GoogleCloudDiscoveryengineV1ListSessionsResponse : Google.Apis.Requests.IDirectResponseSchema + { + /// Pagination token, if not returned indicates the last page. + [Newtonsoft.Json.JsonPropertyAttribute("nextPageToken")] + public virtual string NextPageToken { get; set; } + + /// All the Sessions for a given data store. + [Newtonsoft.Json.JsonPropertyAttribute("sessions")] + public virtual System.Collections.Generic.IList Sessions { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + /// Response message for SiteSearchEngineService.ListTargetSites method. public class GoogleCloudDiscoveryengineV1ListTargetSitesResponse : Google.Apis.Requests.IDirectResponseSchema { @@ -13853,6 +16290,96 @@ public class GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse public virtual string ETag { get; set; } } + /// Defines a user inputed query. + public class GoogleCloudDiscoveryengineV1Query : Google.Apis.Requests.IDirectResponseSchema + { + /// Unique Id for the query. + [Newtonsoft.Json.JsonPropertyAttribute("queryId")] + public virtual string QueryId { get; set; } + + /// Plain text. + [Newtonsoft.Json.JsonPropertyAttribute("text")] + public virtual string Text { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + + /// Request message for RankService.Rank method. + public class GoogleCloudDiscoveryengineV1RankRequest : Google.Apis.Requests.IDirectResponseSchema + { + /// + /// If true, the response will contain only record ID and score. By default, it is false, the response will + /// contain record details. + /// + [Newtonsoft.Json.JsonPropertyAttribute("ignoreRecordDetailsInResponse")] + public virtual System.Nullable IgnoreRecordDetailsInResponse { get; set; } + + /// + /// The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model + /// with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified. + /// + [Newtonsoft.Json.JsonPropertyAttribute("model")] + public virtual string Model { get; set; } + + /// The query to use. + [Newtonsoft.Json.JsonPropertyAttribute("query")] + public virtual string Query { get; set; } + + /// Required. A list of records to rank. At most 200 records to rank. + [Newtonsoft.Json.JsonPropertyAttribute("records")] + public virtual System.Collections.Generic.IList Records { get; set; } + + /// + /// The number of results to return. If this is unset or no bigger than zero, returns all results. + /// + [Newtonsoft.Json.JsonPropertyAttribute("topN")] + public virtual System.Nullable TopN { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + + /// Response message for RankService.Rank method. + public class GoogleCloudDiscoveryengineV1RankResponse : Google.Apis.Requests.IDirectResponseSchema + { + /// A list of records sorted by descending score. + [Newtonsoft.Json.JsonPropertyAttribute("records")] + public virtual System.Collections.Generic.IList Records { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + + /// Record message for RankService.Rank method. + public class GoogleCloudDiscoveryengineV1RankingRecord : Google.Apis.Requests.IDirectResponseSchema + { + /// + /// The content of the record. Empty by default. At least one of title or content should be set otherwise an + /// INVALID_ARGUMENT error is thrown. + /// + [Newtonsoft.Json.JsonPropertyAttribute("content")] + public virtual string Content { get; set; } + + /// The unique ID to represent the record. + [Newtonsoft.Json.JsonPropertyAttribute("id")] + public virtual string Id { get; set; } + + /// The score of this record based on the given query and selected model. + [Newtonsoft.Json.JsonPropertyAttribute("score")] + public virtual System.Nullable Score { get; set; } + + /// + /// The title of the record. Empty by default. At least one of title or content should be set otherwise an + /// INVALID_ARGUMENT error is thrown. + /// + [Newtonsoft.Json.JsonPropertyAttribute("title")] + public virtual string Title { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + /// Request message for Recommend method. public class GoogleCloudDiscoveryengineV1RecommendRequest : Google.Apis.Requests.IDirectResponseSchema { @@ -13863,30 +16390,30 @@ public class GoogleCloudDiscoveryengineV1RecommendRequest : Google.Apis.Requests /// ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based /// expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", /// "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR - /// (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) - /// popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in - /// RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with - /// `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices. + /// (categories: ANY("Movie")) If your filter blocks all results, the API returns generic (unfiltered) popular + /// Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in + /// RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with + /// `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices. /// [Newtonsoft.Json.JsonPropertyAttribute("filter")] public virtual string Filter { get; set; } /// /// Maximum number of results to return. Set this property to the number of recommendation results needed. If - /// zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will - /// be coerced to 100. + /// zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set + /// to 100. /// [Newtonsoft.Json.JsonPropertyAttribute("pageSize")] public virtual System.Nullable PageSize { get; set; } /// /// Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. - /// If set to true, the associated Document object will be returned in + /// If set to `true`, the associated Document object is returned in /// RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the - /// recommendation 'score' corresponding to each returned Document will be set in - /// RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document + /// recommendation score corresponding to each returned Document is set in + /// RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document /// conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to - /// false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks + /// `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks /// all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs /// to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` /// This gives request-level control and adjusts recommendation results based on Document category. * @@ -13922,7 +16449,7 @@ public class GoogleCloudDiscoveryengineV1RecommendRequest : Google.Apis.Requests public virtual System.Collections.Generic.IDictionary UserLabels { get; set; } /// - /// Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns + /// Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns /// arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the /// model is not ready. /// @@ -13977,7 +16504,7 @@ public class GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult : public virtual string Id { get; set; } /// - /// Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double + /// Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double /// value. Is set if `returnScore` is set to true in RecommendRequest.params. /// [Newtonsoft.Json.JsonPropertyAttribute("metadata")] @@ -14074,7 +16601,7 @@ public class GoogleCloudDiscoveryengineV1SearchRequest : Google.Apis.Requests.ID { /// /// Boost specification to boost certain documents. For more information on boosting, see - /// [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + /// [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) /// [Newtonsoft.Json.JsonPropertyAttribute("boostSpec")] public virtual GoogleCloudDiscoveryengineV1SearchRequestBoostSpec BoostSpec { get; set; } @@ -14102,7 +16629,11 @@ public class GoogleCloudDiscoveryengineV1SearchRequest : Google.Apis.Requests.ID [Newtonsoft.Json.JsonPropertyAttribute("contentSearchSpec")] public virtual GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec ContentSearchSpec { get; set; } - /// A list of data store specs to apply on a search call. + /// + /// Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is + /// only considered for engines with multiple dataStores use case. For single dataStore within an engine, they + /// should use the specs at the top level. + /// [Newtonsoft.Json.JsonPropertyAttribute("dataStoreSpecs")] public virtual System.Collections.Generic.IList DataStoreSpecs { get; set; } @@ -14167,10 +16698,10 @@ public class GoogleCloudDiscoveryengineV1SearchRequest : Google.Apis.Requests.ID /// /// Additional search parameters. For public website search only, supported values are: * `user_country_code`: /// string. Default empty. If set to non-empty, results are restricted or boosted based on the location - /// provided. Example: user_country_code: "au" For available codes see [Country + /// provided. For example, `user_country_code: "au"` For available codes see [Country /// Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: /// double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default - /// value is 1, which enables image searching. Example: search_type: 1 + /// value is 1, which enables image searching. For example, `search_type: 1` /// [Newtonsoft.Json.JsonPropertyAttribute("params")] public virtual System.Collections.Generic.IDictionary Params__ { get; set; } @@ -14477,7 +17008,10 @@ public class GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySp public virtual string ETag { get; set; } } - /// A struct to define data stores to filter on in a search call. + /// + /// A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum + /// of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + /// public class GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec : Google.Apis.Requests.IDirectResponseSchema { /// @@ -14534,9 +17068,9 @@ public class GoogleCloudDiscoveryengineV1SearchRequestFacetSpec : Google.Apis.Re public virtual GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey FacetKey { get; set; } /// - /// Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum - /// allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` - /// is returned. + /// Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed + /// value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is + /// returned. /// [Newtonsoft.Json.JsonPropertyAttribute("limit")] public virtual System.Nullable Limit { get; set; } @@ -14556,7 +17090,7 @@ public class GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey : Google public virtual System.Nullable CaseInsensitive { get; set; } /// - /// Only get facet values that contains the given strings. For example, suppose "category" has three values + /// Only get facet values that contain the given strings. For example, suppose "category" has three values /// "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the /// "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual /// fields. Maximum is 10. @@ -14643,8 +17177,7 @@ public class GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec : Googl public class GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec : Google.Apis.Requests.IDirectResponseSchema { /// - /// The mode under which spell correction should take effect to replace the original search query. Default to - /// Mode.AUTO. + /// The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. /// [Newtonsoft.Json.JsonPropertyAttribute("mode")] public virtual string Mode { get; set; } @@ -14722,7 +17255,8 @@ public class GoogleCloudDiscoveryengineV1SearchResponseFacet : Google.Apis.Reque public virtual System.Nullable DynamicFacet { get; set; } /// - /// The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key. + /// The key for this facet. For example, `"colors"` or `"price"`. It matches + /// SearchRequest.FacetSpec.FacetKey.key. /// [Newtonsoft.Json.JsonPropertyAttribute("key")] public virtual string Key { get; set; } @@ -14779,7 +17313,8 @@ public class GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo : Goog public class GoogleCloudDiscoveryengineV1SearchResponseSearchResult : Google.Apis.Requests.IDirectResponseSchema { /// - /// The document data snippet in the search response. Only fields that are marked as retrievable are populated. + /// The document data snippet in the search response. Only fields that are marked as `retrievable` are + /// populated. /// [Newtonsoft.Json.JsonPropertyAttribute("document")] public virtual GoogleCloudDiscoveryengineV1Document Document { get; set; } @@ -14792,7 +17327,7 @@ public class GoogleCloudDiscoveryengineV1SearchResponseSearchResult : Google.Api public virtual string ETag { get; set; } } - /// Summary of the top N search result specified by the summary spec. + /// Summary of the top N search results specified by the summary spec. public class GoogleCloudDiscoveryengineV1SearchResponseSummary : Google.Apis.Requests.IDirectResponseSchema { /// A collection of Safety Attribute categories and their associated confidence scores. @@ -14943,6 +17478,124 @@ public class GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadat public virtual string ETag { get; set; } } + /// External session proto definition. + public class GoogleCloudDiscoveryengineV1Session : Google.Apis.Requests.IDirectResponseSchema + { + private string _endTimeRaw; + + private object _endTime; + + /// Output only. The time the session finished. + [Newtonsoft.Json.JsonPropertyAttribute("endTime")] + public virtual string EndTimeRaw + { + get => _endTimeRaw; + set + { + _endTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value); + _endTimeRaw = value; + } + } + + /// representation of . + [Newtonsoft.Json.JsonIgnoreAttribute] + [System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")] + public virtual object EndTime + { + get => _endTime; + set + { + _endTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value); + _endTime = value; + } + } + + /// representation of . + [Newtonsoft.Json.JsonIgnoreAttribute] + public virtual System.DateTimeOffset? EndTimeDateTimeOffset + { + get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(EndTimeRaw); + set => EndTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value); + } + + /// + /// Immutable. Fully qualified name + /// `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` + /// + [Newtonsoft.Json.JsonPropertyAttribute("name")] + public virtual string Name { get; set; } + + private string _startTimeRaw; + + private object _startTime; + + /// Output only. The time the session started. + [Newtonsoft.Json.JsonPropertyAttribute("startTime")] + public virtual string StartTimeRaw + { + get => _startTimeRaw; + set + { + _startTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value); + _startTimeRaw = value; + } + } + + /// representation of . + [Newtonsoft.Json.JsonIgnoreAttribute] + [System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")] + public virtual object StartTime + { + get => _startTime; + set + { + _startTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value); + _startTime = value; + } + } + + /// representation of . + [Newtonsoft.Json.JsonIgnoreAttribute] + public virtual System.DateTimeOffset? StartTimeDateTimeOffset + { + get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(StartTimeRaw); + set => StartTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value); + } + + /// The state of the session. + [Newtonsoft.Json.JsonPropertyAttribute("state")] + public virtual string State { get; set; } + + /// Turns. + [Newtonsoft.Json.JsonPropertyAttribute("turns")] + public virtual System.Collections.Generic.IList Turns { get; set; } + + /// A unique identifier for tracking users. + [Newtonsoft.Json.JsonPropertyAttribute("userPseudoId")] + public virtual string UserPseudoId { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + + /// Represents a turn, including a query from the user and a answer from service. + public class GoogleCloudDiscoveryengineV1SessionTurn : Google.Apis.Requests.IDirectResponseSchema + { + /// + /// The resource name of the answer to the user query. Only set if the answer generation (/answer API call) + /// happened in this turn. + /// + [Newtonsoft.Json.JsonPropertyAttribute("answer")] + public virtual string Answer { get; set; } + + /// The user query. + [Newtonsoft.Json.JsonPropertyAttribute("query")] + public virtual GoogleCloudDiscoveryengineV1Query Query { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + /// /// SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per /// data store. @@ -15402,7 +18055,7 @@ public virtual object UpdateTime /// /// UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with - /// customers' website. + /// your website. /// public class GoogleCloudDiscoveryengineV1UserEvent : Google.Apis.Requests.IDirectResponseSchema { @@ -15566,7 +18219,7 @@ public virtual object EventTime /// /// A list of identifiers for the independent experiment groups this user event belongs to. This is used to - /// distinguish between user events associated with different experiment setups on the customer end. + /// distinguish between user events associated with different experiment setups. /// [Newtonsoft.Json.JsonPropertyAttribute("tagIds")] public virtual System.Collections.Generic.IList TagIds { get; set; } @@ -17396,7 +20049,7 @@ public virtual object CreateTime /// /// The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on /// DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore - /// liniked to the engine. + /// linked to the engine. /// [Newtonsoft.Json.JsonPropertyAttribute("industryVertical")] public virtual string IndustryVertical { get; set; } @@ -19112,7 +21765,10 @@ public virtual object StartTime /// Represents a turn, including a query from the user and a answer from service. public class GoogleCloudDiscoveryengineV1alphaSessionTurn : Google.Apis.Requests.IDirectResponseSchema { - /// The resource name of the answer to the user query. + /// + /// The resource name of the answer to the user query. Only set if the answer generation (/answer API call) + /// happened in this turn. + /// [Newtonsoft.Json.JsonPropertyAttribute("answer")] public virtual string Answer { get; set; } @@ -20886,7 +23542,7 @@ public virtual object CreateTime /// /// The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on /// DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore - /// liniked to the engine. + /// linked to the engine. /// [Newtonsoft.Json.JsonPropertyAttribute("industryVertical")] public virtual string IndustryVertical { get; set; } diff --git a/Src/Generated/Google.Apis.DiscoveryEngine.v1/Google.Apis.DiscoveryEngine.v1.csproj b/Src/Generated/Google.Apis.DiscoveryEngine.v1/Google.Apis.DiscoveryEngine.v1.csproj index 5d930b0665..92cf305e3f 100644 --- a/Src/Generated/Google.Apis.DiscoveryEngine.v1/Google.Apis.DiscoveryEngine.v1.csproj +++ b/Src/Generated/Google.Apis.DiscoveryEngine.v1/Google.Apis.DiscoveryEngine.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.DiscoveryEngine.v1 Client Library - 1.68.0.3419 + 1.68.0.3424 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.DiscoveryEngine.v1alpha/Google.Apis.DiscoveryEngine.v1alpha.cs b/Src/Generated/Google.Apis.DiscoveryEngine.v1alpha/Google.Apis.DiscoveryEngine.v1alpha.cs index f65ed39345..c04882cfee 100644 --- a/Src/Generated/Google.Apis.DiscoveryEngine.v1alpha/Google.Apis.DiscoveryEngine.v1alpha.cs +++ b/Src/Generated/Google.Apis.DiscoveryEngine.v1alpha/Google.Apis.DiscoveryEngine.v1alpha.cs @@ -760,8 +760,8 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Di public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the Document, which will become the final component of - /// the Document.name. If the caller does not have permission to create the Document, + /// Required. The ID to use for the Document, which becomes the final component of the + /// Document.name. If the caller does not have permission to create the Document, /// regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. /// This field must be unique among all Documents with the same parent. Otherwise, an /// `ALREADY_EXISTS` error is returned. This field must conform to @@ -968,7 +968,7 @@ public enum ProcessedDocumentFormatEnum PROCESSEDDOCUMENTFORMATUNSPECIFIED = 0, /// - /// output format will be a JSON string representation of processed document. + /// Output format is a JSON string representation of processed document. /// [Google.Apis.Util.StringValueAttribute("JSON")] JSON = 1, @@ -1042,8 +1042,8 @@ protected override void InitParameters() /// /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing - /// items will be created. Note: It is possible for a subset of the Documents to be - /// successfully updated. + /// items are created. Note: It is possible for a subset of the Documents to be successfully + /// updated. /// /// The body of the request. /// @@ -1058,8 +1058,8 @@ public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1alpha.Data.Goo /// /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing - /// items will be created. Note: It is possible for a subset of the Documents to be - /// successfully updated. + /// items are created. Note: It is possible for a subset of the Documents to be successfully + /// updated. /// public class ImportRequest : DiscoveryEngineBaseServiceRequest { @@ -1145,8 +1145,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// Maximum number of Documents to return. If unspecified, defaults to 100. The maximum - /// allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is - /// negative, an `INVALID_ARGUMENT` error is returned. + /// allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, + /// an `INVALID_ARGUMENT` error is returned. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -1233,14 +1233,14 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis public virtual string Name { get; private set; } /// - /// If set to true, and the Document is not found, a new Document will be created. + /// If set to `true` and the Document is not found, a new Document is be created. /// [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable AllowMissing { get; set; } /// - /// Indicates which fields in the provided imported 'document' to update. If not set, - /// will by default update all fields. + /// Indicates which fields in the provided imported 'document' to update. If not set, by + /// default updates all fields. /// [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] public virtual object UpdateMask { get; set; } @@ -2648,7 +2648,7 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Di public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the Schema, which will become the final component of the + /// Required. The ID to use for the Schema, which becomes the final component of the /// Schema.name. This field should conform to /// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 /// characters. @@ -2825,8 +2825,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// The maximum number of Schemas to return. The service may return fewer than this value. - /// If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values - /// above 1000 will be coerced to 1000. + /// If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values + /// above 1000 are set to 1000. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -2911,8 +2911,8 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis public virtual string Name { get; private set; } /// - /// If set to true, and the Schema is not found, a new Schema will be created. In this - /// situation, `update_mask` is ignored. + /// If set to true, and the Schema is not found, a new Schema is created. In this situation, + /// `update_mask` is ignored. /// [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable AllowMissing { get; set; } @@ -3260,8 +3260,8 @@ protected override void InitParameters() /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default - /// serving config is created along with your recommendation engine creation. The engine ID will - /// be used as the ID of the default serving config. For example, for Engine + /// serving config is created along with your recommendation engine creation. The engine ID is + /// used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for /// your RecommendationService.Recommend requests. @@ -3287,7 +3287,7 @@ public RecommendRequest(Google.Apis.Services.IClientService service, Google.Apis /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default /// serving config is created along with your recommendation engine creation. The engine ID - /// will be used as the ID of the default serving config. For example, for Engine + /// is used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` /// for your RecommendationService.Recommend requests. @@ -5176,7 +5176,7 @@ protected override void InitParameters() } /// - /// Bulk import of User events. Request processing might be synchronous. Events that already + /// Bulk import of user events. Request processing might be synchronous. Events that already /// exist are skipped. Use this method for backfilling historical user events. /// Operation.response is of type ImportResponse. Note that it is possible for a subset of the /// items to be successfully inserted. Operation.metadata is of type ImportMetadata. @@ -5192,7 +5192,7 @@ public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1alpha.Data.Goo } /// - /// Bulk import of User events. Request processing might be synchronous. Events that already + /// Bulk import of user events. Request processing might be synchronous. Events that already /// exist are skipped. Use this method for backfilling historical user events. /// Operation.response is of type ImportResponse. Note that it is possible for a subset of the /// items to be successfully inserted. Operation.metadata is of type ImportMetadata. @@ -7078,8 +7078,8 @@ protected override void InitParameters() /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default - /// serving config is created along with your recommendation engine creation. The engine ID will - /// be used as the ID of the default serving config. For example, for Engine + /// serving config is created along with your recommendation engine creation. The engine ID is + /// used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for /// your RecommendationService.Recommend requests. @@ -7105,7 +7105,7 @@ public RecommendRequest(Google.Apis.Services.IClientService service, Google.Apis /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default /// serving config is created along with your recommendation engine creation. The engine ID - /// will be used as the ID of the default serving config. For example, for Engine + /// is used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` /// for your RecommendationService.Recommend requests. @@ -8625,7 +8625,7 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Di public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the Document, which will become the final component of the + /// Required. The ID to use for the Document, which becomes the final component of the /// Document.name. If the caller does not have permission to create the Document, regardless /// of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be /// unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is @@ -8833,7 +8833,7 @@ public enum ProcessedDocumentFormatEnum PROCESSEDDOCUMENTFORMATUNSPECIFIED = 0, /// - /// output format will be a JSON string representation of processed document. + /// Output format is a JSON string representation of processed document. /// [Google.Apis.Util.StringValueAttribute("JSON")] JSON = 1, @@ -8905,8 +8905,7 @@ protected override void InitParameters() /// /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items - /// will be created. Note: It is possible for a subset of the Documents to be successfully - /// updated. + /// are created. Note: It is possible for a subset of the Documents to be successfully updated. /// /// The body of the request. /// @@ -8921,8 +8920,7 @@ public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1alpha.Data.Goo /// /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items - /// will be created. Note: It is possible for a subset of the Documents to be successfully - /// updated. + /// are created. Note: It is possible for a subset of the Documents to be successfully updated. /// public class ImportRequest : DiscoveryEngineBaseServiceRequest { @@ -9007,8 +9005,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// Maximum number of Documents to return. If unspecified, defaults to 100. The maximum - /// allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is - /// negative, an `INVALID_ARGUMENT` error is returned. + /// allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an + /// `INVALID_ARGUMENT` error is returned. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -9095,14 +9093,14 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis public virtual string Name { get; private set; } /// - /// If set to true, and the Document is not found, a new Document will be created. + /// If set to `true` and the Document is not found, a new Document is be created. /// [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable AllowMissing { get; set; } /// - /// Indicates which fields in the provided imported 'document' to update. If not set, will - /// by default update all fields. + /// Indicates which fields in the provided imported 'document' to update. If not set, by + /// default updates all fields. /// [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] public virtual object UpdateMask { get; set; } @@ -10281,7 +10279,7 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Di public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the Schema, which will become the final component of the + /// Required. The ID to use for the Schema, which becomes the final component of the /// Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) /// standard with a length limit of 63 characters. /// @@ -10457,8 +10455,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// The maximum number of Schemas to return. The service may return fewer than this value. If - /// unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above - /// 1000 will be coerced to 1000. + /// unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 + /// are set to 1000. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -10543,8 +10541,8 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis public virtual string Name { get; private set; } /// - /// If set to true, and the Schema is not found, a new Schema will be created. In this - /// situation, `update_mask` is ignored. + /// If set to true, and the Schema is not found, a new Schema is created. In this situation, + /// `update_mask` is ignored. /// [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable AllowMissing { get; set; } @@ -10892,8 +10890,8 @@ protected override void InitParameters() /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving - /// config is created along with your recommendation engine creation. The engine ID will be used as - /// the ID of the default serving config. For example, for Engine + /// config is created along with your recommendation engine creation. The engine ID is used as the + /// ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your /// RecommendationService.Recommend requests. @@ -10918,8 +10916,8 @@ public RecommendRequest(Google.Apis.Services.IClientService service, Google.Apis /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default - /// serving config is created along with your recommendation engine creation. The engine ID will - /// be used as the ID of the default serving config. For example, for Engine + /// serving config is created along with your recommendation engine creation. The engine ID is + /// used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for /// your RecommendationService.Recommend requests. @@ -12331,7 +12329,7 @@ protected override void InitParameters() } /// - /// Bulk import of User events. Request processing might be synchronous. Events that already exist + /// Bulk import of user events. Request processing might be synchronous. Events that already exist /// are skipped. Use this method for backfilling historical user events. Operation.response is of /// type ImportResponse. Note that it is possible for a subset of the items to be successfully /// inserted. Operation.metadata is of type ImportMetadata. @@ -12347,7 +12345,7 @@ public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1alpha.Data.Goo } /// - /// Bulk import of User events. Request processing might be synchronous. Events that already exist + /// Bulk import of user events. Request processing might be synchronous. Events that already exist /// are skipped. Use this method for backfilling historical user events. Operation.response is of /// type ImportResponse. Note that it is possible for a subset of the items to be successfully /// inserted. Operation.metadata is of type ImportMetadata. @@ -15671,7 +15669,7 @@ public virtual object CreateTime /// /// The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on /// DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore - /// liniked to the engine. + /// linked to the engine. /// [Newtonsoft.Json.JsonPropertyAttribute("industryVertical")] public virtual string IndustryVertical { get; set; } @@ -16976,7 +16974,7 @@ public class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest : Google.Apis.R /// /// The session resource name. Not required. When session field is not set, the API is in sessionless mode. We - /// support auto session mode: users can use the wildcard symbol “-” as session id. A new id will be + /// support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be /// automatically generated and assigned. /// [Newtonsoft.Json.JsonPropertyAttribute("session")] @@ -18037,7 +18035,7 @@ public class GoogleCloudDiscoveryengineV1alphaChunk : Google.Apis.Requests.IDire /// /// Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score - /// is in range [0.0, 1.0]. Only populated on SearchService.SearchResponse + /// is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse /// [Newtonsoft.Json.JsonPropertyAttribute("relevanceScore")] public virtual System.Nullable RelevanceScore { get; set; } @@ -19693,9 +19691,9 @@ public class GoogleCloudDiscoveryengineV1alphaDocumentInfo : Google.Apis.Request public virtual System.Collections.Generic.IList PromotionIds { get; set; } /// - /// Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if - /// two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the - /// following event types: * `add-to-cart` * `purchase` + /// Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two + /// quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following + /// event types: * `add-to-cart` * `purchase` /// [Newtonsoft.Json.JsonPropertyAttribute("quantity")] public virtual System.Nullable Quantity { get; set; } @@ -20025,7 +20023,7 @@ public virtual object CreateTime /// /// The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on /// DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore - /// liniked to the engine. + /// linked to the engine. /// [Newtonsoft.Json.JsonPropertyAttribute("industryVertical")] public virtual string IndustryVertical { get; set; } @@ -20664,7 +20662,8 @@ public class GoogleCloudDiscoveryengineV1alphaFieldConfig : Google.Apis.Requests public class GoogleCloudDiscoveryengineV1alphaFirestoreSource : Google.Apis.Requests.IDirectResponseSchema { /// - /// Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. + /// Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 + /// characters. /// [Newtonsoft.Json.JsonPropertyAttribute("collectionId")] public virtual string CollectionId { get; set; } @@ -20706,15 +20705,15 @@ public class GoogleCloudDiscoveryengineV1alphaGcsSource : Google.Apis.Requests.I /// arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC /// Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. /// Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store - /// vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + /// vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. /// [Newtonsoft.Json.JsonPropertyAttribute("dataSchema")] public virtual string DataSchema { get; set; } /// - /// Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full - /// object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such - /// as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if + /// Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the + /// full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, + /// such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if /// `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). /// [Newtonsoft.Json.JsonPropertyAttribute("inputUris")] @@ -22369,30 +22368,30 @@ public class GoogleCloudDiscoveryengineV1alphaRecommendRequest : Google.Apis.Req /// ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based /// expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", /// "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR - /// (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) - /// popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in - /// RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with - /// `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices. + /// (categories: ANY("Movie")) If your filter blocks all results, the API returns generic (unfiltered) popular + /// Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in + /// RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with + /// `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices. /// [Newtonsoft.Json.JsonPropertyAttribute("filter")] public virtual string Filter { get; set; } /// /// Maximum number of results to return. Set this property to the number of recommendation results needed. If - /// zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will - /// be coerced to 100. + /// zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set + /// to 100. /// [Newtonsoft.Json.JsonPropertyAttribute("pageSize")] public virtual System.Nullable PageSize { get; set; } /// /// Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. - /// If set to true, the associated Document object will be returned in + /// If set to `true`, the associated Document object is returned in /// RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the - /// recommendation 'score' corresponding to each returned Document will be set in - /// RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document + /// recommendation score corresponding to each returned Document is set in + /// RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document /// conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to - /// false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks + /// `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks /// all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs /// to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` /// This gives request-level control and adjusts recommendation results based on Document category. * @@ -22428,7 +22427,7 @@ public class GoogleCloudDiscoveryengineV1alphaRecommendRequest : Google.Apis.Req public virtual System.Collections.Generic.IDictionary UserLabels { get; set; } /// - /// Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns + /// Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns /// arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the /// model is not ready. /// @@ -22483,7 +22482,7 @@ public class GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationRes public virtual string Id { get; set; } /// - /// Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double + /// Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double /// value. Is set if `returnScore` is set to true in RecommendRequest.params. /// [Newtonsoft.Json.JsonPropertyAttribute("metadata")] @@ -22806,7 +22805,7 @@ public class GoogleCloudDiscoveryengineV1alphaSearchRequest : Google.Apis.Reques { /// /// Boost specification to boost certain documents. For more information on boosting, see - /// [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + /// [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) /// [Newtonsoft.Json.JsonPropertyAttribute("boostSpec")] public virtual GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec BoostSpec { get; set; } @@ -22838,7 +22837,11 @@ public class GoogleCloudDiscoveryengineV1alphaSearchRequest : Google.Apis.Reques [Newtonsoft.Json.JsonPropertyAttribute("customFineTuningSpec")] public virtual GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec CustomFineTuningSpec { get; set; } - /// A list of data store specs to apply on a search call. + /// + /// Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is + /// only considered for engines with multiple dataStores use case. For single dataStore within an engine, they + /// should use the specs at the top level. + /// [Newtonsoft.Json.JsonPropertyAttribute("dataStoreSpecs")] public virtual System.Collections.Generic.IList DataStoreSpecs { get; set; } @@ -22913,10 +22916,10 @@ public class GoogleCloudDiscoveryengineV1alphaSearchRequest : Google.Apis.Reques /// /// Additional search parameters. For public website search only, supported values are: * `user_country_code`: /// string. Default empty. If set to non-empty, results are restricted or boosted based on the location - /// provided. Example: user_country_code: "au" For available codes see [Country + /// provided. For example, `user_country_code: "au"` For available codes see [Country /// Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: /// double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default - /// value is 1, which enables image searching. Example: search_type: 1 + /// value is 1, which enables image searching. For example, `search_type: 1` /// [Newtonsoft.Json.JsonPropertyAttribute("params")] public virtual System.Collections.Generic.IDictionary Params__ { get; set; } @@ -23339,7 +23342,10 @@ public class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSumm public virtual string ETag { get; set; } } - /// A struct to define data stores to filter on in a search call. + /// + /// A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum + /// of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + /// public class GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec : Google.Apis.Requests.IDirectResponseSchema { /// @@ -23424,9 +23430,9 @@ public class GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec : Google.Ap public virtual GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey FacetKey { get; set; } /// - /// Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum - /// allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` - /// is returned. + /// Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed + /// value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is + /// returned. /// [Newtonsoft.Json.JsonPropertyAttribute("limit")] public virtual System.Nullable Limit { get; set; } @@ -23446,7 +23452,7 @@ public class GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey : G public virtual System.Nullable CaseInsensitive { get; set; } /// - /// Only get facet values that contains the given strings. For example, suppose "category" has three values + /// Only get facet values that contain the given strings. For example, suppose "category" has three values /// "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the /// "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual /// fields. Maximum is 10. @@ -23533,8 +23539,7 @@ public class GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec : public class GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec : Google.Apis.Requests.IDirectResponseSchema { /// - /// The mode under which spell correction should take effect to replace the original search query. Default to - /// Mode.AUTO. + /// The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. /// [Newtonsoft.Json.JsonPropertyAttribute("mode")] public virtual string Mode { get; set; } @@ -23623,7 +23628,8 @@ public class GoogleCloudDiscoveryengineV1alphaSearchResponseFacet : Google.Apis. public virtual System.Nullable DynamicFacet { get; set; } /// - /// The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key. + /// The key for this facet. For example, `"colors"` or `"price"`. It matches + /// SearchRequest.FacetSpec.FacetKey.key. /// [Newtonsoft.Json.JsonPropertyAttribute("key")] public virtual string Key { get; set; } @@ -23696,11 +23702,11 @@ public class GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult : /// Useful attribute for search result refinements. public class GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute : Google.Apis.Requests.IDirectResponseSchema { - /// Attribute key used to refine the results e.g. 'movie_type'. + /// Attribute key used to refine the results. For example, `"movie_type"`. [Newtonsoft.Json.JsonPropertyAttribute("attributeKey")] public virtual string AttributeKey { get; set; } - /// Attribute value used to refine the results e.g. 'drama'. + /// Attribute value used to refine the results. For example, `"drama"`. [Newtonsoft.Json.JsonPropertyAttribute("attributeValue")] public virtual string AttributeValue { get; set; } @@ -23737,7 +23743,8 @@ public class GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult : Googl public virtual GoogleCloudDiscoveryengineV1alphaChunk Chunk { get; set; } /// - /// The document data snippet in the search response. Only fields that are marked as retrievable are populated. + /// The document data snippet in the search response. Only fields that are marked as `retrievable` are + /// populated. /// [Newtonsoft.Json.JsonPropertyAttribute("document")] public virtual GoogleCloudDiscoveryengineV1alphaDocument Document { get; set; } @@ -23754,7 +23761,7 @@ public class GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult : Googl public virtual string ETag { get; set; } } - /// Summary of the top N search result specified by the summary spec. + /// Summary of the top N search results specified by the summary spec. public class GoogleCloudDiscoveryengineV1alphaSearchResponseSummary : Google.Apis.Requests.IDirectResponseSchema { /// A collection of Safety Attribute categories and their associated confidence scores. @@ -24288,7 +24295,10 @@ public virtual object StartTime /// Represents a turn, including a query from the user and a answer from service. public class GoogleCloudDiscoveryengineV1alphaSessionTurn : Google.Apis.Requests.IDirectResponseSchema { - /// The resource name of the answer to the user query. + /// + /// The resource name of the answer to the user query. Only set if the answer generation (/answer API call) + /// happened in this turn. + /// [Newtonsoft.Json.JsonPropertyAttribute("answer")] public virtual string Answer { get; set; } @@ -24975,7 +24985,7 @@ public virtual object UpdateTime /// /// UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with - /// customers' website. + /// your website. /// public class GoogleCloudDiscoveryengineV1alphaUserEvent : Google.Apis.Requests.IDirectResponseSchema { @@ -25139,7 +25149,7 @@ public virtual object EventTime /// /// A list of identifiers for the independent experiment groups this user event belongs to. This is used to - /// distinguish between user events associated with different experiment setups on the customer end. + /// distinguish between user events associated with different experiment setups. /// [Newtonsoft.Json.JsonPropertyAttribute("tagIds")] public virtual System.Collections.Generic.IList TagIds { get; set; } @@ -26489,7 +26499,7 @@ public virtual object CreateTime /// /// The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on /// DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore - /// liniked to the engine. + /// linked to the engine. /// [Newtonsoft.Json.JsonPropertyAttribute("industryVertical")] public virtual string IndustryVertical { get; set; } diff --git a/Src/Generated/Google.Apis.DiscoveryEngine.v1alpha/Google.Apis.DiscoveryEngine.v1alpha.csproj b/Src/Generated/Google.Apis.DiscoveryEngine.v1alpha/Google.Apis.DiscoveryEngine.v1alpha.csproj index c37d5d85c3..9fcbc4b85e 100644 --- a/Src/Generated/Google.Apis.DiscoveryEngine.v1alpha/Google.Apis.DiscoveryEngine.v1alpha.csproj +++ b/Src/Generated/Google.Apis.DiscoveryEngine.v1alpha/Google.Apis.DiscoveryEngine.v1alpha.csproj @@ -3,7 +3,7 @@ Google.Apis.DiscoveryEngine.v1alpha Client Library - 1.68.0.3419 + 1.68.0.3424 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.DiscoveryEngine.v1beta/Google.Apis.DiscoveryEngine.v1beta.cs b/Src/Generated/Google.Apis.DiscoveryEngine.v1beta/Google.Apis.DiscoveryEngine.v1beta.cs index a7cfa84148..260730d781 100644 --- a/Src/Generated/Google.Apis.DiscoveryEngine.v1beta/Google.Apis.DiscoveryEngine.v1beta.cs +++ b/Src/Generated/Google.Apis.DiscoveryEngine.v1beta/Google.Apis.DiscoveryEngine.v1beta.cs @@ -591,8 +591,8 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Di public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the Document, which will become the final component of - /// the Document.name. If the caller does not have permission to create the Document, + /// Required. The ID to use for the Document, which becomes the final component of the + /// Document.name. If the caller does not have permission to create the Document, /// regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. /// This field must be unique among all Documents with the same parent. Otherwise, an /// `ALREADY_EXISTS` error is returned. This field must conform to @@ -756,8 +756,8 @@ protected override void InitParameters() /// /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing - /// items will be created. Note: It is possible for a subset of the Documents to be - /// successfully updated. + /// items are created. Note: It is possible for a subset of the Documents to be successfully + /// updated. /// /// The body of the request. /// @@ -772,8 +772,8 @@ public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1beta.Data.Goog /// /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing - /// items will be created. Note: It is possible for a subset of the Documents to be - /// successfully updated. + /// items are created. Note: It is possible for a subset of the Documents to be successfully + /// updated. /// public class ImportRequest : DiscoveryEngineBaseServiceRequest { @@ -859,8 +859,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// Maximum number of Documents to return. If unspecified, defaults to 100. The maximum - /// allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is - /// negative, an `INVALID_ARGUMENT` error is returned. + /// allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, + /// an `INVALID_ARGUMENT` error is returned. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -947,14 +947,14 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis public virtual string Name { get; private set; } /// - /// If set to true, and the Document is not found, a new Document will be created. + /// If set to `true` and the Document is not found, a new Document is be created. /// [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable AllowMissing { get; set; } /// - /// Indicates which fields in the provided imported 'document' to update. If not set, - /// will by default update all fields. + /// Indicates which fields in the provided imported 'document' to update. If not set, by + /// default updates all fields. /// [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] public virtual object UpdateMask { get; set; } @@ -2362,7 +2362,7 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Di public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the Schema, which will become the final component of the + /// Required. The ID to use for the Schema, which becomes the final component of the /// Schema.name. This field should conform to /// [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 /// characters. @@ -2539,8 +2539,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// The maximum number of Schemas to return. The service may return fewer than this value. - /// If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values - /// above 1000 will be coerced to 1000. + /// If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values + /// above 1000 are set to 1000. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -2625,8 +2625,8 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis public virtual string Name { get; private set; } /// - /// If set to true, and the Schema is not found, a new Schema will be created. In this - /// situation, `update_mask` is ignored. + /// If set to true, and the Schema is not found, a new Schema is created. In this situation, + /// `update_mask` is ignored. /// [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable AllowMissing { get; set; } @@ -2974,8 +2974,8 @@ protected override void InitParameters() /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default - /// serving config is created along with your recommendation engine creation. The engine ID will - /// be used as the ID of the default serving config. For example, for Engine + /// serving config is created along with your recommendation engine creation. The engine ID is + /// used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for /// your RecommendationService.Recommend requests. @@ -3001,7 +3001,7 @@ public RecommendRequest(Google.Apis.Services.IClientService service, Google.Apis /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default /// serving config is created along with your recommendation engine creation. The engine ID - /// will be used as the ID of the default serving config. For example, for Engine + /// is used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` /// for your RecommendationService.Recommend requests. @@ -4890,7 +4890,7 @@ protected override void InitParameters() } /// - /// Bulk import of User events. Request processing might be synchronous. Events that already + /// Bulk import of user events. Request processing might be synchronous. Events that already /// exist are skipped. Use this method for backfilling historical user events. /// Operation.response is of type ImportResponse. Note that it is possible for a subset of the /// items to be successfully inserted. Operation.metadata is of type ImportMetadata. @@ -4906,7 +4906,7 @@ public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1beta.Data.Goog } /// - /// Bulk import of User events. Request processing might be synchronous. Events that already + /// Bulk import of user events. Request processing might be synchronous. Events that already /// exist are skipped. Use this method for backfilling historical user events. /// Operation.response is of type ImportResponse. Note that it is possible for a subset of the /// items to be successfully inserted. Operation.metadata is of type ImportMetadata. @@ -6590,8 +6590,8 @@ protected override void InitParameters() /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default - /// serving config is created along with your recommendation engine creation. The engine ID will - /// be used as the ID of the default serving config. For example, for Engine + /// serving config is created along with your recommendation engine creation. The engine ID is + /// used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for /// your RecommendationService.Recommend requests. @@ -6617,7 +6617,7 @@ public RecommendRequest(Google.Apis.Services.IClientService service, Google.Apis /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default /// serving config is created along with your recommendation engine creation. The engine ID - /// will be used as the ID of the default serving config. For example, for Engine + /// is used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` /// for your RecommendationService.Recommend requests. @@ -7971,7 +7971,7 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Di public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the Document, which will become the final component of the + /// Required. The ID to use for the Document, which becomes the final component of the /// Document.name. If the caller does not have permission to create the Document, regardless /// of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be /// unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is @@ -8136,8 +8136,7 @@ protected override void InitParameters() /// /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items - /// will be created. Note: It is possible for a subset of the Documents to be successfully - /// updated. + /// are created. Note: It is possible for a subset of the Documents to be successfully updated. /// /// The body of the request. /// @@ -8152,8 +8151,7 @@ public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1beta.Data.Goog /// /// Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items - /// will be created. Note: It is possible for a subset of the Documents to be successfully - /// updated. + /// are created. Note: It is possible for a subset of the Documents to be successfully updated. /// public class ImportRequest : DiscoveryEngineBaseServiceRequest { @@ -8238,8 +8236,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// Maximum number of Documents to return. If unspecified, defaults to 100. The maximum - /// allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is - /// negative, an `INVALID_ARGUMENT` error is returned. + /// allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an + /// `INVALID_ARGUMENT` error is returned. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -8326,14 +8324,14 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis public virtual string Name { get; private set; } /// - /// If set to true, and the Document is not found, a new Document will be created. + /// If set to `true` and the Document is not found, a new Document is be created. /// [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable AllowMissing { get; set; } /// - /// Indicates which fields in the provided imported 'document' to update. If not set, will - /// by default update all fields. + /// Indicates which fields in the provided imported 'document' to update. If not set, by + /// default updates all fields. /// [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)] public virtual object UpdateMask { get; set; } @@ -9512,7 +9510,7 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Di public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the Schema, which will become the final component of the + /// Required. The ID to use for the Schema, which becomes the final component of the /// Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) /// standard with a length limit of 63 characters. /// @@ -9688,8 +9686,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// The maximum number of Schemas to return. The service may return fewer than this value. If - /// unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above - /// 1000 will be coerced to 1000. + /// unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 + /// are set to 1000. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -9774,8 +9772,8 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Dis public virtual string Name { get; private set; } /// - /// If set to true, and the Schema is not found, a new Schema will be created. In this - /// situation, `update_mask` is ignored. + /// If set to true, and the Schema is not found, a new Schema is created. In this situation, + /// `update_mask` is ignored. /// [Google.Apis.Util.RequestParameterAttribute("allowMissing", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable AllowMissing { get; set; } @@ -10123,8 +10121,8 @@ protected override void InitParameters() /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving - /// config is created along with your recommendation engine creation. The engine ID will be used as - /// the ID of the default serving config. For example, for Engine + /// config is created along with your recommendation engine creation. The engine ID is used as the + /// ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your /// RecommendationService.Recommend requests. @@ -10149,8 +10147,8 @@ public RecommendRequest(Google.Apis.Services.IClientService service, Google.Apis /// Required. Full resource name of a ServingConfig: /// `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or /// `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default - /// serving config is created along with your recommendation engine creation. The engine ID will - /// be used as the ID of the default serving config. For example, for Engine + /// serving config is created along with your recommendation engine creation. The engine ID is + /// used as the ID of the default serving config. For example, for Engine /// `projects/*/locations/global/collections/*/engines/my-engine`, you can use /// `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for /// your RecommendationService.Recommend requests. @@ -11562,7 +11560,7 @@ protected override void InitParameters() } /// - /// Bulk import of User events. Request processing might be synchronous. Events that already exist + /// Bulk import of user events. Request processing might be synchronous. Events that already exist /// are skipped. Use this method for backfilling historical user events. Operation.response is of /// type ImportResponse. Note that it is possible for a subset of the items to be successfully /// inserted. Operation.metadata is of type ImportMetadata. @@ -11578,7 +11576,7 @@ public virtual ImportRequest Import(Google.Apis.DiscoveryEngine.v1beta.Data.Goog } /// - /// Bulk import of User events. Request processing might be synchronous. Events that already exist + /// Bulk import of user events. Request processing might be synchronous. Events that already exist /// are skipped. Use this method for backfilling historical user events. Operation.response is of /// type ImportResponse. Note that it is possible for a subset of the items to be successfully /// inserted. Operation.metadata is of type ImportMetadata. @@ -14177,7 +14175,7 @@ public virtual object CreateTime /// /// The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on /// DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore - /// liniked to the engine. + /// linked to the engine. /// [Newtonsoft.Json.JsonPropertyAttribute("industryVertical")] public virtual string IndustryVertical { get; set; } @@ -17046,7 +17044,7 @@ public virtual object CreateTime /// /// The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on /// DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore - /// liniked to the engine. + /// linked to the engine. /// [Newtonsoft.Json.JsonPropertyAttribute("industryVertical")] public virtual string IndustryVertical { get; set; } @@ -18762,7 +18760,10 @@ public virtual object StartTime /// Represents a turn, including a query from the user and a answer from service. public class GoogleCloudDiscoveryengineV1alphaSessionTurn : Google.Apis.Requests.IDirectResponseSchema { - /// The resource name of the answer to the user query. + /// + /// The resource name of the answer to the user query. Only set if the answer generation (/answer API call) + /// happened in this turn. + /// [Newtonsoft.Json.JsonPropertyAttribute("answer")] public virtual string Answer { get; set; } @@ -19433,7 +19434,7 @@ public class GoogleCloudDiscoveryengineV1betaAnswerQueryRequest : Google.Apis.Re /// /// The session resource name. Not required. When session field is not set, the API is in sessionless mode. We - /// support auto session mode: users can use the wildcard symbol “-” as session id. A new id will be + /// support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be /// automatically generated and assigned. /// [Newtonsoft.Json.JsonPropertyAttribute("session")] @@ -21967,9 +21968,9 @@ public class GoogleCloudDiscoveryengineV1betaDocumentInfo : Google.Apis.Requests public virtual System.Collections.Generic.IList PromotionIds { get; set; } /// - /// Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if - /// two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the - /// following event types: * `add-to-cart` * `purchase` + /// Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two + /// quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following + /// event types: * `add-to-cart` * `purchase` /// [Newtonsoft.Json.JsonPropertyAttribute("quantity")] public virtual System.Nullable Quantity { get; set; } @@ -22253,7 +22254,7 @@ public virtual object CreateTime /// /// The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on /// DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore - /// liniked to the engine. + /// linked to the engine. /// [Newtonsoft.Json.JsonPropertyAttribute("industryVertical")] public virtual string IndustryVertical { get; set; } @@ -22505,7 +22506,8 @@ public class GoogleCloudDiscoveryengineV1betaFhirStoreSource : Google.Apis.Reque public class GoogleCloudDiscoveryengineV1betaFirestoreSource : Google.Apis.Requests.IDirectResponseSchema { /// - /// Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. + /// Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 + /// characters. /// [Newtonsoft.Json.JsonPropertyAttribute("collectionId")] public virtual string CollectionId { get; set; } @@ -22547,15 +22549,15 @@ public class GoogleCloudDiscoveryengineV1betaGcsSource : Google.Apis.Requests.ID /// arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC /// Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. /// Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store - /// vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + /// vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. /// [Newtonsoft.Json.JsonPropertyAttribute("dataSchema")] public virtual string DataSchema { get; set; } /// - /// Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full - /// object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such - /// as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if + /// Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the + /// full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, + /// such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if /// `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). /// [Newtonsoft.Json.JsonPropertyAttribute("inputUris")] @@ -23717,30 +23719,30 @@ public class GoogleCloudDiscoveryengineV1betaRecommendRequest : Google.Apis.Requ /// ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based /// expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", /// "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR - /// (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) - /// popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in - /// RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with - /// `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices. + /// (categories: ANY("Movie")) If your filter blocks all results, the API returns generic (unfiltered) popular + /// Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in + /// RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with + /// `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices. /// [Newtonsoft.Json.JsonPropertyAttribute("filter")] public virtual string Filter { get; set; } /// /// Maximum number of results to return. Set this property to the number of recommendation results needed. If - /// zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will - /// be coerced to 100. + /// zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set + /// to 100. /// [Newtonsoft.Json.JsonPropertyAttribute("pageSize")] public virtual System.Nullable PageSize { get; set; } /// /// Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. - /// If set to true, the associated Document object will be returned in + /// If set to `true`, the associated Document object is returned in /// RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the - /// recommendation 'score' corresponding to each returned Document will be set in - /// RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document + /// recommendation score corresponding to each returned Document is set in + /// RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document /// conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to - /// false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks + /// `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks /// all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs /// to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` /// This gives request-level control and adjusts recommendation results based on Document category. * @@ -23776,7 +23778,7 @@ public class GoogleCloudDiscoveryengineV1betaRecommendRequest : Google.Apis.Requ public virtual System.Collections.Generic.IDictionary UserLabels { get; set; } /// - /// Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns + /// Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns /// arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the /// model is not ready. /// @@ -23831,7 +23833,7 @@ public class GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResu public virtual string Id { get; set; } /// - /// Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double + /// Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double /// value. Is set if `returnScore` is set to true in RecommendRequest.params. /// [Newtonsoft.Json.JsonPropertyAttribute("metadata")] @@ -23966,7 +23968,7 @@ public class GoogleCloudDiscoveryengineV1betaSearchRequest : Google.Apis.Request { /// /// Boost specification to boost certain documents. For more information on boosting, see - /// [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + /// [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) /// [Newtonsoft.Json.JsonPropertyAttribute("boostSpec")] public virtual GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec BoostSpec { get; set; } @@ -23994,7 +23996,11 @@ public class GoogleCloudDiscoveryengineV1betaSearchRequest : Google.Apis.Request [Newtonsoft.Json.JsonPropertyAttribute("contentSearchSpec")] public virtual GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec ContentSearchSpec { get; set; } - /// A list of data store specs to apply on a search call. + /// + /// Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is + /// only considered for engines with multiple dataStores use case. For single dataStore within an engine, they + /// should use the specs at the top level. + /// [Newtonsoft.Json.JsonPropertyAttribute("dataStoreSpecs")] public virtual System.Collections.Generic.IList DataStoreSpecs { get; set; } @@ -24069,10 +24075,10 @@ public class GoogleCloudDiscoveryengineV1betaSearchRequest : Google.Apis.Request /// /// Additional search parameters. For public website search only, supported values are: * `user_country_code`: /// string. Default empty. If set to non-empty, results are restricted or boosted based on the location - /// provided. Example: user_country_code: "au" For available codes see [Country + /// provided. For example, `user_country_code: "au"` For available codes see [Country /// Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: /// double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default - /// value is 1, which enables image searching. Example: search_type: 1 + /// value is 1, which enables image searching. For example, `search_type: 1` /// [Newtonsoft.Json.JsonPropertyAttribute("params")] public virtual System.Collections.Generic.IDictionary Params__ { get; set; } @@ -24456,7 +24462,10 @@ public class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSumma public virtual string ETag { get; set; } } - /// A struct to define data stores to filter on in a search call. + /// + /// A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum + /// of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + /// public class GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec : Google.Apis.Requests.IDirectResponseSchema { /// @@ -24541,9 +24550,9 @@ public class GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec : Google.Api public virtual GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey FacetKey { get; set; } /// - /// Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum - /// allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` - /// is returned. + /// Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed + /// value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is + /// returned. /// [Newtonsoft.Json.JsonPropertyAttribute("limit")] public virtual System.Nullable Limit { get; set; } @@ -24563,7 +24572,7 @@ public class GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey : Go public virtual System.Nullable CaseInsensitive { get; set; } /// - /// Only get facet values that contains the given strings. For example, suppose "category" has three values + /// Only get facet values that contain the given strings. For example, suppose "category" has three values /// "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the /// "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual /// fields. Maximum is 10. @@ -24650,8 +24659,7 @@ public class GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec : G public class GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec : Google.Apis.Requests.IDirectResponseSchema { /// - /// The mode under which spell correction should take effect to replace the original search query. Default to - /// Mode.AUTO. + /// The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. /// [Newtonsoft.Json.JsonPropertyAttribute("mode")] public virtual string Mode { get; set; } @@ -24740,7 +24748,8 @@ public class GoogleCloudDiscoveryengineV1betaSearchResponseFacet : Google.Apis.R public virtual System.Nullable DynamicFacet { get; set; } /// - /// The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key. + /// The key for this facet. For example, `"colors"` or `"price"`. It matches + /// SearchRequest.FacetSpec.FacetKey.key. /// [Newtonsoft.Json.JsonPropertyAttribute("key")] public virtual string Key { get; set; } @@ -24813,11 +24822,11 @@ public class GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult : /// Useful attribute for search result refinements. public class GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute : Google.Apis.Requests.IDirectResponseSchema { - /// Attribute key used to refine the results e.g. 'movie_type'. + /// Attribute key used to refine the results. For example, `"movie_type"`. [Newtonsoft.Json.JsonPropertyAttribute("attributeKey")] public virtual string AttributeKey { get; set; } - /// Attribute value used to refine the results e.g. 'drama'. + /// Attribute value used to refine the results. For example, `"drama"`. [Newtonsoft.Json.JsonPropertyAttribute("attributeValue")] public virtual string AttributeValue { get; set; } @@ -24847,7 +24856,8 @@ public class GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo : public class GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult : Google.Apis.Requests.IDirectResponseSchema { /// - /// The document data snippet in the search response. Only fields that are marked as retrievable are populated. + /// The document data snippet in the search response. Only fields that are marked as `retrievable` are + /// populated. /// [Newtonsoft.Json.JsonPropertyAttribute("document")] public virtual GoogleCloudDiscoveryengineV1betaDocument Document { get; set; } @@ -24864,7 +24874,7 @@ public class GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult : Google public virtual string ETag { get; set; } } - /// Summary of the top N search result specified by the summary spec. + /// Summary of the top N search results specified by the summary spec. public class GoogleCloudDiscoveryengineV1betaSearchResponseSummary : Google.Apis.Requests.IDirectResponseSchema { /// A collection of Safety Attribute categories and their associated confidence scores. @@ -25390,7 +25400,10 @@ public virtual object StartTime /// Represents a turn, including a query from the user and a answer from service. public class GoogleCloudDiscoveryengineV1betaSessionTurn : Google.Apis.Requests.IDirectResponseSchema { - /// The resource name of the answer to the user query. + /// + /// The resource name of the answer to the user query. Only set if the answer generation (/answer API call) + /// happened in this turn. + /// [Newtonsoft.Json.JsonPropertyAttribute("answer")] public virtual string Answer { get; set; } @@ -26077,7 +26090,7 @@ public virtual object UpdateTime /// /// UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with - /// customers' website. + /// your website. /// public class GoogleCloudDiscoveryengineV1betaUserEvent : Google.Apis.Requests.IDirectResponseSchema { @@ -26241,7 +26254,7 @@ public virtual object EventTime /// /// A list of identifiers for the independent experiment groups this user event belongs to. This is used to - /// distinguish between user events associated with different experiment setups on the customer end. + /// distinguish between user events associated with different experiment setups. /// [Newtonsoft.Json.JsonPropertyAttribute("tagIds")] public virtual System.Collections.Generic.IList TagIds { get; set; } diff --git a/Src/Generated/Google.Apis.DiscoveryEngine.v1beta/Google.Apis.DiscoveryEngine.v1beta.csproj b/Src/Generated/Google.Apis.DiscoveryEngine.v1beta/Google.Apis.DiscoveryEngine.v1beta.csproj index 13351405b0..1a239a7b01 100644 --- a/Src/Generated/Google.Apis.DiscoveryEngine.v1beta/Google.Apis.DiscoveryEngine.v1beta.csproj +++ b/Src/Generated/Google.Apis.DiscoveryEngine.v1beta/Google.Apis.DiscoveryEngine.v1beta.csproj @@ -3,7 +3,7 @@ Google.Apis.DiscoveryEngine.v1beta Client Library - 1.68.0.3419 + 1.68.0.3424 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.Fcmdata.v1beta1/Google.Apis.Fcmdata.v1beta1.cs b/Src/Generated/Google.Apis.Fcmdata.v1beta1/Google.Apis.Fcmdata.v1beta1.cs index c054556a5c..ffae6b58f4 100644 --- a/Src/Generated/Google.Apis.Fcmdata.v1beta1/Google.Apis.Fcmdata.v1beta1.cs +++ b/Src/Generated/Google.Apis.Fcmdata.v1beta1/Google.Apis.Fcmdata.v1beta1.cs @@ -430,12 +430,19 @@ public class GoogleFirebaseFcmDataV1beta1AndroidDeliveryData : Google.Apis.Reque public class GoogleFirebaseFcmDataV1beta1Data : Google.Apis.Requests.IDirectResponseSchema { /// - /// Count of messages accepted by FCM intended to Android devices. The targeted device must have opted in to the - /// collection of usage and diagnostic information. + /// Count of messages accepted by FCM intended for Android devices. The targeted device must have opted in to + /// the collection of usage and diagnostic information. /// [Newtonsoft.Json.JsonPropertyAttribute("countMessagesAccepted")] public virtual System.Nullable CountMessagesAccepted { get; set; } + /// + /// Count of notifications accepted by FCM intended for Android devices. The targeted device must have opted in + /// to the collection of usage and diagnostic information. + /// + [Newtonsoft.Json.JsonPropertyAttribute("countNotificationsAccepted")] + public virtual System.Nullable CountNotificationsAccepted { get; set; } + /// /// Additional information about delivery performance for messages that were successfully delivered. /// @@ -450,6 +457,10 @@ public class GoogleFirebaseFcmDataV1beta1Data : Google.Apis.Requests.IDirectResp [Newtonsoft.Json.JsonPropertyAttribute("messageOutcomePercents")] public virtual GoogleFirebaseFcmDataV1beta1MessageOutcomePercents MessageOutcomePercents { get; set; } + /// Additional insights about proxy notification delivery. + [Newtonsoft.Json.JsonPropertyAttribute("proxyNotificationInsightPercents")] + public virtual GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents ProxyNotificationInsightPercents { get; set; } + /// The ETag of the item. public virtual string ETag { get; set; } } @@ -595,6 +606,58 @@ public class GoogleFirebaseFcmDataV1beta1MessageOutcomePercents : Google.Apis.Re public virtual string ETag { get; set; } } + /// + /// Additional information about proxy notification delivery. All percentages are calculated with + /// countNotificationsAccepted as the denominator. + /// + public class GoogleFirebaseFcmDataV1beta1ProxyNotificationInsightPercents : Google.Apis.Requests.IDirectResponseSchema + { + /// + /// The percentage of accepted notifications that failed to be proxied. This is usually caused by exceptions + /// that occurred while calling + /// [notifyAsPackage](https://developer.android.com/reference/android/app/NotificationManager#notifyAsPackage%28java.lang.String,%20java.lang.String,%20int,%20android.app.Notification%29). + /// + [Newtonsoft.Json.JsonPropertyAttribute("failed")] + public virtual System.Nullable Failed { get; set; } + + /// + /// The percentage of accepted notifications that were successfully proxied by [Google Play + /// services](https://developers.google.com/android/guides/overview). + /// + [Newtonsoft.Json.JsonPropertyAttribute("proxied")] + public virtual System.Nullable Proxied { get; set; } + + /// + /// The percentage of accepted notifications that were skipped because the messages were not throttled. + /// + [Newtonsoft.Json.JsonPropertyAttribute("skippedNotThrottled")] + public virtual System.Nullable SkippedNotThrottled { get; set; } + + /// + /// The percentage of accepted notifications that were skipped because the app disallowed these messages to be + /// proxied. + /// + [Newtonsoft.Json.JsonPropertyAttribute("skippedOptedOut")] + public virtual System.Nullable SkippedOptedOut { get; set; } + + /// + /// The percentage of accepted notifications that were skipped because configurations required for notifications + /// to be proxied were missing. + /// + [Newtonsoft.Json.JsonPropertyAttribute("skippedUnconfigured")] + public virtual System.Nullable SkippedUnconfigured { get; set; } + + /// + /// The percentage of accepted notifications that were skipped because proxy notification is unsupported for the + /// recipient. + /// + [Newtonsoft.Json.JsonPropertyAttribute("skippedUnsupported")] + public virtual System.Nullable SkippedUnsupported { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + /// /// Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either /// specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one diff --git a/Src/Generated/Google.Apis.Fcmdata.v1beta1/Google.Apis.Fcmdata.v1beta1.csproj b/Src/Generated/Google.Apis.Fcmdata.v1beta1/Google.Apis.Fcmdata.v1beta1.csproj index 7247ca4fb4..81ce815a6d 100644 --- a/Src/Generated/Google.Apis.Fcmdata.v1beta1/Google.Apis.Fcmdata.v1beta1.csproj +++ b/Src/Generated/Google.Apis.Fcmdata.v1beta1/Google.Apis.Fcmdata.v1beta1.csproj @@ -3,7 +3,7 @@ Google.Apis.Fcmdata.v1beta1 Client Library - 1.68.0.2651 + 1.68.0.3428 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.FirebaseML.v2beta/Google.Apis.FirebaseML.v2beta.cs b/Src/Generated/Google.Apis.FirebaseML.v2beta/Google.Apis.FirebaseML.v2beta.cs index c5c8c7e3b0..ff6bf0d6f3 100644 --- a/Src/Generated/Google.Apis.FirebaseML.v2beta/Google.Apis.FirebaseML.v2beta.cs +++ b/Src/Generated/Google.Apis.FirebaseML.v2beta/Google.Apis.FirebaseML.v2beta.cs @@ -920,6 +920,15 @@ public class GenerationConfig : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("responseMimeType")] public virtual string ResponseMimeType { get; set; } + /// + /// 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. + /// + [Newtonsoft.Json.JsonPropertyAttribute("responseSchema")] + public virtual Schema ResponseSchema { get; set; } + /// Optional. Stop sequences. [Newtonsoft.Json.JsonPropertyAttribute("stopSequences")] public virtual System.Collections.Generic.IList StopSequences { get; set; } diff --git a/Src/Generated/Google.Apis.FirebaseML.v2beta/Google.Apis.FirebaseML.v2beta.csproj b/Src/Generated/Google.Apis.FirebaseML.v2beta/Google.Apis.FirebaseML.v2beta.csproj index b6a1f53c56..20da94711b 100644 --- a/Src/Generated/Google.Apis.FirebaseML.v2beta/Google.Apis.FirebaseML.v2beta.csproj +++ b/Src/Generated/Google.Apis.FirebaseML.v2beta/Google.Apis.FirebaseML.v2beta.csproj @@ -3,7 +3,7 @@ Google.Apis.FirebaseML.v2beta Client Library - 1.68.0.3423 + 1.68.0.3428 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.Firestore.v1/Google.Apis.Firestore.v1.cs b/Src/Generated/Google.Apis.Firestore.v1/Google.Apis.Firestore.v1.cs index 6bee991e3a..bbc79b445c 100644 --- a/Src/Generated/Google.Apis.Firestore.v1/Google.Apis.Firestore.v1.cs +++ b/Src/Generated/Google.Apis.Firestore.v1/Google.Apis.Firestore.v1.cs @@ -5321,8 +5321,7 @@ public virtual object CreateTime private object _deleteTime; /// - /// Output only. The timestamp at which this database was soft deleted. Only set if the database has been soft - /// deleted. + /// Output only. The timestamp at which this database was deleted. Only set if the database has been deleted. /// [Newtonsoft.Json.JsonPropertyAttribute("deleteTime")] public virtual string DeleteTimeRaw @@ -5704,7 +5703,10 @@ public virtual object StartTime /// The request for FirestoreAdmin.ExportDocuments. public class GoogleFirestoreAdminV1ExportDocumentsRequest : Google.Apis.Requests.IDirectResponseSchema { - /// Which collection ids to export. Unspecified means all collections. + /// + /// Which collection ids to export. Unspecified means all collections. Each collection id in this list must be + /// unique. + /// [Newtonsoft.Json.JsonPropertyAttribute("collectionIds")] public virtual System.Collections.Generic.IList CollectionIds { get; set; } @@ -6055,7 +6057,10 @@ public virtual object StartTime /// The request for FirestoreAdmin.ImportDocuments. public class GoogleFirestoreAdminV1ImportDocumentsRequest : Google.Apis.Requests.IDirectResponseSchema { - /// Which collection ids to import. Unspecified means all collections included in the import. + /// + /// Which collection ids to import. Unspecified means all collections included in the import. Each collection id + /// in this list must be unique. + /// [Newtonsoft.Json.JsonPropertyAttribute("collectionIds")] public virtual System.Collections.Generic.IList CollectionIds { get; set; } diff --git a/Src/Generated/Google.Apis.Firestore.v1/Google.Apis.Firestore.v1.csproj b/Src/Generated/Google.Apis.Firestore.v1/Google.Apis.Firestore.v1.csproj index b233f52db7..c92e1ceafa 100644 --- a/Src/Generated/Google.Apis.Firestore.v1/Google.Apis.Firestore.v1.csproj +++ b/Src/Generated/Google.Apis.Firestore.v1/Google.Apis.Firestore.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.Firestore.v1 Client Library - 1.68.0.3419 + 1.68.0.3428 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.Gmail.v1/Google.Apis.Gmail.v1.cs b/Src/Generated/Google.Apis.Gmail.v1/Google.Apis.Gmail.v1.cs index 28909a3eb1..3248d9028f 100644 --- a/Src/Generated/Google.Apis.Gmail.v1/Google.Apis.Gmail.v1.cs +++ b/Src/Generated/Google.Apis.Gmail.v1/Google.Apis.Gmail.v1.cs @@ -1927,9 +1927,6 @@ public GetRequest(Google.Apis.Services.IClientService service, string userId, st [Google.Apis.Util.RequestParameterAttribute("id", Google.Apis.Util.RequestParameterType.Path)] public virtual string Id { get; private set; } - [Google.Apis.Util.RequestParameterAttribute("temporaryEeccBypass", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable TemporaryEeccBypass { get; set; } - /// Gets the method name. public override string MethodName => "get"; @@ -1967,14 +1964,6 @@ protected override void InitParameters() DefaultValue = null, Pattern = null, }); - RequestParameters.Add("temporaryEeccBypass", new Google.Apis.Discovery.Parameter - { - Name = "temporaryEeccBypass", - IsRequired = false, - ParameterType = "query", - DefaultValue = "false", - Pattern = null, - }); } } } @@ -2243,9 +2232,6 @@ public enum FormatEnum [Google.Apis.Util.RequestParameterAttribute("metadataHeaders", Google.Apis.Util.RequestParameterType.Query)] public virtual Google.Apis.Util.Repeatable MetadataHeaders { get; set; } - [Google.Apis.Util.RequestParameterAttribute("temporaryEeccBypass", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable TemporaryEeccBypass { get; set; } - /// Gets the method name. public override string MethodName => "get"; @@ -2291,14 +2277,6 @@ protected override void InitParameters() DefaultValue = null, Pattern = null, }); - RequestParameters.Add("temporaryEeccBypass", new Google.Apis.Discovery.Parameter - { - Name = "temporaryEeccBypass", - IsRequired = false, - ParameterType = "query", - DefaultValue = "false", - Pattern = null, - }); } } @@ -2957,9 +2935,6 @@ public ListRequest(Google.Apis.Services.IClientService service, string userId) : [Google.Apis.Util.RequestParameterAttribute("q", Google.Apis.Util.RequestParameterType.Query)] public virtual string Q { get; set; } - [Google.Apis.Util.RequestParameterAttribute("temporaryEeccBypass", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable TemporaryEeccBypass { get; set; } - /// Gets the method name. public override string MethodName => "list"; @@ -3021,14 +2996,6 @@ protected override void InitParameters() DefaultValue = null, Pattern = null, }); - RequestParameters.Add("temporaryEeccBypass", new Google.Apis.Discovery.Parameter - { - Name = "temporaryEeccBypass", - IsRequired = false, - ParameterType = "query", - DefaultValue = "false", - Pattern = null, - }); } } @@ -6791,9 +6758,6 @@ public enum FormatEnum [Google.Apis.Util.RequestParameterAttribute("metadataHeaders", Google.Apis.Util.RequestParameterType.Query)] public virtual Google.Apis.Util.Repeatable MetadataHeaders { get; set; } - [Google.Apis.Util.RequestParameterAttribute("temporaryEeccBypass", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable TemporaryEeccBypass { get; set; } - /// Gets the method name. public override string MethodName => "get"; @@ -6839,14 +6803,6 @@ protected override void InitParameters() DefaultValue = null, Pattern = null, }); - RequestParameters.Add("temporaryEeccBypass", new Google.Apis.Discovery.Parameter - { - Name = "temporaryEeccBypass", - IsRequired = false, - ParameterType = "query", - DefaultValue = "false", - Pattern = null, - }); } } @@ -6902,9 +6858,6 @@ public ListRequest(Google.Apis.Services.IClientService service, string userId) : [Google.Apis.Util.RequestParameterAttribute("q", Google.Apis.Util.RequestParameterType.Query)] public virtual string Q { get; set; } - [Google.Apis.Util.RequestParameterAttribute("temporaryEeccBypass", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable TemporaryEeccBypass { get; set; } - /// Gets the method name. public override string MethodName => "list"; @@ -6966,14 +6919,6 @@ protected override void InitParameters() DefaultValue = null, Pattern = null, }); - RequestParameters.Add("temporaryEeccBypass", new Google.Apis.Discovery.Parameter - { - Name = "temporaryEeccBypass", - IsRequired = false, - ParameterType = "query", - DefaultValue = "false", - Pattern = null, - }); } } @@ -7216,9 +7161,6 @@ public GetProfileRequest(Google.Apis.Services.IClientService service, string use [Google.Apis.Util.RequestParameterAttribute("userId", Google.Apis.Util.RequestParameterType.Path)] public virtual string UserId { get; private set; } - [Google.Apis.Util.RequestParameterAttribute("temporaryEeccBypass", Google.Apis.Util.RequestParameterType.Query)] - public virtual System.Nullable TemporaryEeccBypass { get; set; } - /// Gets the method name. public override string MethodName => "getProfile"; @@ -7240,14 +7182,6 @@ protected override void InitParameters() DefaultValue = "me", Pattern = null, }); - RequestParameters.Add("temporaryEeccBypass", new Google.Apis.Discovery.Parameter - { - Name = "temporaryEeccBypass", - IsRequired = false, - ParameterType = "query", - DefaultValue = "false", - Pattern = null, - }); } } diff --git a/Src/Generated/Google.Apis.Gmail.v1/Google.Apis.Gmail.v1.csproj b/Src/Generated/Google.Apis.Gmail.v1/Google.Apis.Gmail.v1.csproj index dc568bd5ac..47516e8898 100644 --- a/Src/Generated/Google.Apis.Gmail.v1/Google.Apis.Gmail.v1.csproj +++ b/Src/Generated/Google.Apis.Gmail.v1/Google.Apis.Gmail.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.Gmail.v1 Client Library - 1.68.0.3399 + 1.68.0.3427 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.GoogleAnalyticsAdmin.v1alpha/Google.Apis.GoogleAnalyticsAdmin.v1alpha.cs b/Src/Generated/Google.Apis.GoogleAnalyticsAdmin.v1alpha/Google.Apis.GoogleAnalyticsAdmin.v1alpha.cs index fb89dc16b1..2b1542b8f3 100644 --- a/Src/Generated/Google.Apis.GoogleAnalyticsAdmin.v1alpha/Google.Apis.GoogleAnalyticsAdmin.v1alpha.cs +++ b/Src/Generated/Google.Apis.GoogleAnalyticsAdmin.v1alpha/Google.Apis.GoogleAnalyticsAdmin.v1alpha.cs @@ -10780,6 +10780,43 @@ public class GoogleAnalyticsAdminV1alphaAudience : Google.Apis.Requests.IDirectR [Newtonsoft.Json.JsonPropertyAttribute("adsPersonalizationEnabled")] public virtual System.Nullable AdsPersonalizationEnabled { get; set; } + private string _createTimeRaw; + + private object _createTime; + + /// Output only. Time when the Audience was created. + [Newtonsoft.Json.JsonPropertyAttribute("createTime")] + public virtual string CreateTimeRaw + { + get => _createTimeRaw; + set + { + _createTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value); + _createTimeRaw = value; + } + } + + /// representation of . + [Newtonsoft.Json.JsonIgnoreAttribute] + [System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")] + public virtual object CreateTime + { + get => _createTime; + set + { + _createTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value); + _createTime = value; + } + } + + /// representation of . + [Newtonsoft.Json.JsonIgnoreAttribute] + public virtual System.DateTimeOffset? CreateTimeDateTimeOffset + { + get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(CreateTimeRaw); + set => CreateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value); + } + /// Required. The description of the Audience. [Newtonsoft.Json.JsonPropertyAttribute("description")] public virtual string Description { get; set; } @@ -11954,13 +11991,6 @@ public class GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse : Google.Ap /// Request message for CreateSubproperty RPC. public class GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest : Google.Apis.Requests.IDirectResponseSchema { - /// - /// Required. The ordinary property for which to create a subproperty. Format: properties/property_id Example: - /// properties/123 - /// - [Newtonsoft.Json.JsonPropertyAttribute("parent")] - public virtual string Parent { get; set; } - /// Required. The subproperty to create. [Newtonsoft.Json.JsonPropertyAttribute("subproperty")] public virtual GoogleAnalyticsAdminV1alphaProperty Subproperty { get; set; } diff --git a/Src/Generated/Google.Apis.GoogleAnalyticsAdmin.v1alpha/Google.Apis.GoogleAnalyticsAdmin.v1alpha.csproj b/Src/Generated/Google.Apis.GoogleAnalyticsAdmin.v1alpha/Google.Apis.GoogleAnalyticsAdmin.v1alpha.csproj index 1f46834911..66ae8c8e78 100644 --- a/Src/Generated/Google.Apis.GoogleAnalyticsAdmin.v1alpha/Google.Apis.GoogleAnalyticsAdmin.v1alpha.csproj +++ b/Src/Generated/Google.Apis.GoogleAnalyticsAdmin.v1alpha/Google.Apis.GoogleAnalyticsAdmin.v1alpha.csproj @@ -3,7 +3,7 @@ Google.Apis.GoogleAnalyticsAdmin.v1alpha Client Library - 1.68.0.3379 + 1.68.0.3428 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.HangoutsChat.v1/Google.Apis.HangoutsChat.v1.cs b/Src/Generated/Google.Apis.HangoutsChat.v1/Google.Apis.HangoutsChat.v1.cs index bed1b60905..2b3145c907 100644 --- a/Src/Generated/Google.Apis.HangoutsChat.v1/Google.Apis.HangoutsChat.v1.cs +++ b/Src/Generated/Google.Apis.HangoutsChat.v1/Google.Apis.HangoutsChat.v1.cs @@ -1060,20 +1060,20 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// and type /// ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To /// filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` - /// to `HUMAN` or `BOT`. To filter by both role and type, use the `AND` operator. To filter by either - /// role or type, use the `OR` operator. For example, the following queries are valid: + /// to `HUMAN` or `BOT`. Developer Preview: You can also filter for `member.type` using the `!=` + /// operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, + /// use the `OR` operator. Either `member.type = "HUMAN"` or `member.type != "BOT"` is required when + /// `use_admin_access` is set to true. Other member type filters will be rejected. For example, the + /// following queries are valid: /// ``` - /// role = - /// "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" + /// role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" + /// AND role = "ROLE_MANAGER" member.type != "BOT" /// ``` - /// The - /// following queries are invalid: + /// The following queries are invalid: /// ``` - /// member.type = "HUMAN" AND member.type = "BOT" role = - /// "ROLE_MANAGER" AND role = "ROLE_MEMBER" + /// member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" /// ``` - /// Invalid queries are rejected by the server with an - /// `INVALID_ARGUMENT` error. + /// Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. /// [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)] public virtual string Filter { get; set; } @@ -1302,7 +1302,8 @@ public AttachmentsResource(Google.Apis.Services.IClientService service) /// authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). /// /// - /// Required. Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`. + /// Required. Resource name of the attachment, in the form + /// `spaces/{space}/messages/{message}/attachments/{attachment}`. /// public virtual GetRequest Get(string name) { @@ -1326,7 +1327,8 @@ public GetRequest(Google.Apis.Services.IClientService service, string name) : ba } /// - /// Required. Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`. + /// Required. Resource name of the attachment, in the form + /// `spaces/{space}/messages/{message}/attachments/{attachment}`. /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] public virtual string Name { get; private set; } @@ -2853,7 +2855,7 @@ protected override void InitParameters() /// authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). /// /// - /// Required. Resource name of the space, in the form "spaces/*". Format: `spaces/{space}` + /// Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}` /// public virtual GetRequest Get(string name) { @@ -2877,7 +2879,7 @@ public GetRequest(Google.Apis.Services.IClientService service, string name) : ba } /// - /// Required. Resource name of the space, in the form "spaces/*". Format: `spaces/{space}` + /// Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}` /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] public virtual string Name { get; private set; } @@ -2913,7 +2915,8 @@ protected override void InitParameters() /// authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user /// authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces /// visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is - /// sent. + /// sent. To list all named spaces by Google Workspace organization, use the `spaces.search()` method using + /// Workspace administrator privileges instead. /// public virtual ListRequest List() { @@ -2927,7 +2930,8 @@ public virtual ListRequest List() /// authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user /// authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces /// visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is - /// sent. + /// sent. To list all named spaces by Google Workspace organization, use the `spaces.search()` method using + /// Workspace administrator privileges instead. /// public class ListRequest : HangoutsChatBaseServiceRequest { @@ -3638,7 +3642,9 @@ public class Attachment : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("driveDataRef")] public virtual DriveDataRef DriveDataRef { get; set; } - /// Resource name of the attachment, in the form `spaces/*/messages/*/attachments/*`. + /// + /// Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`. + /// [Newtonsoft.Json.JsonPropertyAttribute("name")] public virtual string Name { get; set; } diff --git a/Src/Generated/Google.Apis.HangoutsChat.v1/Google.Apis.HangoutsChat.v1.csproj b/Src/Generated/Google.Apis.HangoutsChat.v1/Google.Apis.HangoutsChat.v1.csproj index 05eb262007..3e86aab768 100644 --- a/Src/Generated/Google.Apis.HangoutsChat.v1/Google.Apis.HangoutsChat.v1.csproj +++ b/Src/Generated/Google.Apis.HangoutsChat.v1/Google.Apis.HangoutsChat.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.HangoutsChat.v1 Client Library - 1.68.0.3416 + 1.68.0.3426 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.Iam.v1/Google.Apis.Iam.v1.cs b/Src/Generated/Google.Apis.Iam.v1/Google.Apis.Iam.v1.cs index d538f5cff0..ecc91c3e41 100644 --- a/Src/Generated/Google.Apis.Iam.v1/Google.Apis.Iam.v1.cs +++ b/Src/Generated/Google.Apis.Iam.v1/Google.Apis.Iam.v1.cs @@ -2297,14 +2297,14 @@ public RolesResource(Google.Apis.Services.IClientService service) /// The body of the request. /// /// The `parent` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `parent` value format is described below: * - /// [`projects.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `parent` value format is described below: * + /// [projects.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): /// `projects/{PROJECT_ID}`. This method creates project-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * - /// [`organizations.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): + /// [organizations.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): /// `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are @@ -2328,14 +2328,14 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Ia /// /// The `parent` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `parent` value format is described below: * - /// [`projects.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): + /// [projects.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): /// `projects/{PROJECT_ID}`. This method creates project-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * - /// [`organizations.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): + /// [organizations.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): /// `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are @@ -2384,15 +2384,15 @@ protected override void InitParameters() /// /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `name` value format is described below: * - /// [`projects.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `name` value format is described below: * + /// [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): + /// [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -2423,15 +2423,15 @@ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `name` value format is described below: * - /// [`projects.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): + /// [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): + /// [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -2480,20 +2480,20 @@ protected override void InitParameters() /// Gets the definition of a Role. /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `name` value format is described below: * - /// [`roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. - /// This method returns results from all [predefined + /// [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `name` value format is described below: * + /// [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This + /// method returns results from all [predefined /// roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request /// URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * - /// [`projects.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): + /// [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): + /// [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -2517,20 +2517,20 @@ public GetRequest(Google.Apis.Services.IClientService service, string name) : ba /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `name` value format is described below: * - /// [`roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. + /// [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. /// This method returns results from all [predefined /// roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example /// request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * - /// [`projects.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): + /// [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): + /// [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -2570,19 +2570,19 @@ protected override void InitParameters() /// /// /// The `parent` parameter's value depends on the target resource for the request, namely - /// [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `parent` value format is described below: * - /// [`roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This + /// [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `parent` value format is described below: * + /// [roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This /// method doesn't require a resource; it simply returns all [predefined /// roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request /// URL: `https://iam.googleapis.com/v1/roles` * - /// [`projects.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): + /// [projects.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): /// `projects/{PROJECT_ID}`. This method lists all project-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * - /// [`organizations.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): + /// [organizations.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): /// `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are @@ -2608,19 +2608,19 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// The `parent` parameter's value depends on the target resource for the request, namely - /// [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `parent` value format is described below: * - /// [`roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. - /// This method doesn't require a resource; it simply returns all [predefined + /// [roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This + /// method doesn't require a resource; it simply returns all [predefined /// roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example /// request URL: `https://iam.googleapis.com/v1/roles` * - /// [`projects.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): + /// [projects.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): /// `projects/{PROJECT_ID}`. This method lists all project-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * - /// [`organizations.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): + /// [organizations.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): /// `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are @@ -2728,15 +2728,15 @@ protected override void InitParameters() /// The body of the request. /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `name` value format is described below: * - /// [`projects.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `name` value format is described below: * + /// [projects.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): + /// [organizations.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -2761,15 +2761,15 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Iam /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `name` value format is described below: * - /// [`projects.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): + /// [projects.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): + /// [organizations.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -2825,15 +2825,15 @@ protected override void InitParameters() /// The body of the request. /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `name` value format is described below: * - /// [`projects.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `name` value format is described below: * + /// [projects.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): + /// [organizations.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -2858,15 +2858,15 @@ public UndeleteRequest(Google.Apis.Services.IClientService service, Google.Apis. /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `name` value format is described below: * - /// [`projects.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): + /// [projects.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): + /// [organizations.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -3042,7 +3042,7 @@ public CredentialsResource(Google.Apis.Services.IClientService service) /// Creates a new OauthClientCredential. /// The body of the request. /// - /// Required. The parent resource to create the oauth client Credential in. + /// Required. The parent resource to create the OauthClientCredential in. /// public virtual CreateRequest Create(Google.Apis.Iam.v1.Data.OauthClientCredential body, string parent) { @@ -3060,13 +3060,13 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Ia InitParameters(); } - /// Required. The parent resource to create the oauth client Credential in. + /// Required. The parent resource to create the OauthClientCredential in. [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the oauth client credential, which becomes the final component - /// of the resource name. This value should be 4-32 characters, and may contain the characters + /// Required. The ID to use for the OauthClientCredential, which becomes the final component of + /// the resource name. This value should be 4-32 characters, and may contain the characters /// [a-z0-9-]. The prefix `gcp-` is reserved for use by Google, and may not be specified. /// [Google.Apis.Util.RequestParameterAttribute("oauthClientCredentialId", Google.Apis.Util.RequestParameterType.Query)] @@ -3111,11 +3111,11 @@ protected override void InitParameters() } /// - /// Deletes a OauthClientCredential. Before deleting an oauth client credential, it should first be + /// Deletes an OauthClientCredential. Before deleting an OauthClientCredential, it should first be /// disabled. /// /// - /// Required. The name of the oauth client credential to delete. Format: + /// Required. The name of the OauthClientCredential to delete. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`. /// public virtual DeleteRequest Delete(string name) @@ -3124,7 +3124,7 @@ public virtual DeleteRequest Delete(string name) } /// - /// Deletes a OauthClientCredential. Before deleting an oauth client credential, it should first be + /// Deletes an OauthClientCredential. Before deleting an OauthClientCredential, it should first be /// disabled. /// public class DeleteRequest : IamBaseServiceRequest @@ -3137,7 +3137,7 @@ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : } /// - /// Required. The name of the oauth client credential to delete. Format: + /// Required. The name of the OauthClientCredential to delete. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`. /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] @@ -3169,7 +3169,7 @@ protected override void InitParameters() /// Gets an individual OauthClientCredential. /// - /// Required. The name of the oauth client credential to retrieve. Format: + /// Required. The name of the OauthClientCredential to retrieve. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`. /// public virtual GetRequest Get(string name) @@ -3188,7 +3188,7 @@ public GetRequest(Google.Apis.Services.IClientService service, string name) : ba } /// - /// Required. The name of the oauth client credential to retrieve. Format: + /// Required. The name of the OauthClientCredential to retrieve. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`. /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] @@ -3218,14 +3218,14 @@ protected override void InitParameters() } } - /// Lists all OauthClientCredentialss in a OauthClient. - /// Required. The parent to list oauth client credentials for. + /// Lists all OauthClientCredentials in an OauthClient. + /// Required. The parent to list OauthClientCredentials for. public virtual ListRequest List(string parent) { return new ListRequest(this.service, parent); } - /// Lists all OauthClientCredentialss in a OauthClient. + /// Lists all OauthClientCredentials in an OauthClient. public class ListRequest : IamBaseServiceRequest { /// Constructs a new List request. @@ -3235,7 +3235,7 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : InitParameters(); } - /// Required. The parent to list oauth client credentials for. + /// Required. The parent to list OauthClientCredentials for. [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] public virtual string Parent { get; private set; } @@ -3266,7 +3266,7 @@ protected override void InitParameters() /// Updates an existing OauthClientCredential. /// The body of the request. /// - /// Immutable. The resource name of the oauth client credential. Format: + /// Immutable. The resource name of the OauthClientCredential. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}` /// public virtual PatchRequest Patch(Google.Apis.Iam.v1.Data.OauthClientCredential body, string name) @@ -3286,7 +3286,7 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Iam } /// - /// Immutable. The resource name of the oauth client credential. Format: + /// Immutable. The resource name of the OauthClientCredential. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}` /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] @@ -3336,13 +3336,12 @@ protected override void InitParameters() } /// - /// Creates a new OauthClient. You cannot reuse the name of a deleted oauth client until 30 days after + /// Creates a new OauthClient. You cannot reuse the name of a deleted OauthClient until 30 days after /// deletion. /// /// The body of the request. /// - /// Required. The parent resource to create the oauth client in. The only supported location is - /// `global`. + /// Required. The parent resource to create the OauthClient in. The only supported location is `global`. /// public virtual CreateRequest Create(Google.Apis.Iam.v1.Data.OauthClient body, string parent) { @@ -3350,7 +3349,7 @@ public virtual CreateRequest Create(Google.Apis.Iam.v1.Data.OauthClient body, st } /// - /// Creates a new OauthClient. You cannot reuse the name of a deleted oauth client until 30 days after + /// Creates a new OauthClient. You cannot reuse the name of a deleted OauthClient until 30 days after /// deletion. /// public class CreateRequest : IamBaseServiceRequest @@ -3364,14 +3363,14 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Ia } /// - /// Required. The parent resource to create the oauth client in. The only supported location is + /// Required. The parent resource to create the OauthClient in. The only supported location is /// `global`. /// [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] public virtual string Parent { get; private set; } /// - /// Required. The ID to use for the oauth client, which becomes the final component of the resource + /// Required. The ID to use for the OauthClient, which becomes the final component of the resource /// name. This value should be a string of 6 to 63 lowercase letters, digits, or hyphens. It must /// start with a letter, and cannot have a trailing hyphen. The prefix `gcp-` is reserved for use by /// Google, and may not be specified. @@ -3418,15 +3417,15 @@ protected override void InitParameters() } /// - /// Deletes a OauthClient. You cannot use a deleted oauth client. However, deletion does not revoke - /// access tokens that have already been issued; they continue to grant access. Deletion does revoke - /// refresh tokens that have already been issued; They cannot be used to renew an access token. If the - /// oauth client is undeleted, and the refresh tokens are not expired, they are valid for token exchange - /// again. You can undelete an oauth client for 30 days. After 30 days, deletion is permanent. You - /// cannot update deleted oauth clients. However, you can view and list them. + /// Deletes an OauthClient. You cannot use a deleted OauthClient. However, deletion does not revoke + /// access tokens that have already been issued. They continue to grant access. Deletion does revoke + /// refresh tokens that have already been issued. They cannot be used to renew an access token. If the + /// OauthClient is undeleted, and the refresh tokens are not expired, they are valid for token exchange + /// again. You can undelete an OauthClient for 30 days. After 30 days, deletion is permanent. You cannot + /// update deleted OauthClients. However, you can view and list them. /// /// - /// Required. The name of the oauth client to delete. Format: + /// Required. The name of the OauthClient to delete. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. /// public virtual DeleteRequest Delete(string name) @@ -3435,12 +3434,12 @@ public virtual DeleteRequest Delete(string name) } /// - /// Deletes a OauthClient. You cannot use a deleted oauth client. However, deletion does not revoke - /// access tokens that have already been issued; they continue to grant access. Deletion does revoke - /// refresh tokens that have already been issued; They cannot be used to renew an access token. If the - /// oauth client is undeleted, and the refresh tokens are not expired, they are valid for token exchange - /// again. You can undelete an oauth client for 30 days. After 30 days, deletion is permanent. You - /// cannot update deleted oauth clients. However, you can view and list them. + /// Deletes an OauthClient. You cannot use a deleted OauthClient. However, deletion does not revoke + /// access tokens that have already been issued. They continue to grant access. Deletion does revoke + /// refresh tokens that have already been issued. They cannot be used to renew an access token. If the + /// OauthClient is undeleted, and the refresh tokens are not expired, they are valid for token exchange + /// again. You can undelete an OauthClient for 30 days. After 30 days, deletion is permanent. You cannot + /// update deleted OauthClients. However, you can view and list them. /// public class DeleteRequest : IamBaseServiceRequest { @@ -3452,7 +3451,7 @@ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : } /// - /// Required. The name of the oauth client to delete. Format: + /// Required. The name of the OauthClient to delete. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] @@ -3484,7 +3483,7 @@ protected override void InitParameters() /// Gets an individual OauthClient. /// - /// Required. The name of the oauth client to retrieve. Format: + /// Required. The name of the OauthClient to retrieve. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. /// public virtual GetRequest Get(string name) @@ -3503,7 +3502,7 @@ public GetRequest(Google.Apis.Services.IClientService service, string name) : ba } /// - /// Required. The name of the oauth client to retrieve. Format: + /// Required. The name of the OauthClient to retrieve. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] @@ -3534,18 +3533,18 @@ protected override void InitParameters() } /// - /// Lists all non-deleted OauthClientss in a project. If `show_deleted` is set to `true`, then deleted - /// oauth clients are also listed. + /// Lists all non-deleted OauthClients in a project. If `show_deleted` is set to `true`, then deleted + /// OauthClients are also listed. /// - /// Required. The parent to list oauth clients for. + /// Required. The parent to list OauthClients for. public virtual ListRequest List(string parent) { return new ListRequest(this.service, parent); } /// - /// Lists all non-deleted OauthClientss in a project. If `show_deleted` is set to `true`, then deleted - /// oauth clients are also listed. + /// Lists all non-deleted OauthClients in a project. If `show_deleted` is set to `true`, then deleted + /// OauthClients are also listed. /// public class ListRequest : IamBaseServiceRequest { @@ -3556,13 +3555,13 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : InitParameters(); } - /// Required. The parent to list oauth clients for. + /// Required. The parent to list OauthClients for. [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)] public virtual string Parent { get; private set; } /// - /// Optional. The maximum number of oauth clients to return. If unspecified, at most 50 oauth - /// clients will be returned. The maximum value is 100; values above 100 are truncated to 100. + /// Optional. The maximum number of OauthClients to return. If unspecified, at most 50 OauthClients + /// will be returned. The maximum value is 100; values above 100 are truncated to 100. /// [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable PageSize { get; set; } @@ -3574,7 +3573,7 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)] public virtual string PageToken { get; set; } - /// Optional. Whether to return soft-deleted oauth clients. + /// Optional. Whether to return soft-deleted OauthClients. [Google.Apis.Util.RequestParameterAttribute("showDeleted", Google.Apis.Util.RequestParameterType.Query)] public virtual System.Nullable ShowDeleted { get; set; } @@ -3629,7 +3628,7 @@ protected override void InitParameters() /// Updates an existing OauthClient. /// The body of the request. /// - /// Immutable. The resource name of the oauth client. + /// Immutable. The resource name of the OauthClient. /// Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`. /// public virtual PatchRequest Patch(Google.Apis.Iam.v1.Data.OauthClient body, string name) @@ -3649,7 +3648,7 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Iam } /// - /// Immutable. The resource name of the oauth client. + /// Immutable. The resource name of the OauthClient. /// Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`. /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] @@ -3697,10 +3696,10 @@ protected override void InitParameters() } } - /// Undeletes a OauthClient, as long as it was deleted fewer than 30 days ago. + /// Undeletes an OauthClient, as long as it was deleted fewer than 30 days ago. /// The body of the request. /// - /// Required. The name of the oauth client to undelete. Format: + /// Required. The name of the OauthClient to undelete. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. /// public virtual UndeleteRequest Undelete(Google.Apis.Iam.v1.Data.UndeleteOauthClientRequest body, string name) @@ -3708,7 +3707,7 @@ public virtual UndeleteRequest Undelete(Google.Apis.Iam.v1.Data.UndeleteOauthCli return new UndeleteRequest(this.service, body, name); } - /// Undeletes a OauthClient, as long as it was deleted fewer than 30 days ago. + /// Undeletes an OauthClient, as long as it was deleted fewer than 30 days ago. public class UndeleteRequest : IamBaseServiceRequest { /// Constructs a new Undelete request. @@ -3720,7 +3719,7 @@ public UndeleteRequest(Google.Apis.Services.IClientService service, Google.Apis. } /// - /// Required. The name of the oauth client to undelete. Format: + /// Required. The name of the OauthClient to undelete. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. /// [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)] @@ -5422,14 +5421,14 @@ public RolesResource(Google.Apis.Services.IClientService service) /// The body of the request. /// /// The `parent` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `parent` value format is described below: * - /// [`projects.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `parent` value format is described below: * + /// [projects.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): /// `projects/{PROJECT_ID}`. This method creates project-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * - /// [`organizations.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): + /// [organizations.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): /// `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are @@ -5453,14 +5452,14 @@ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Ia /// /// The `parent` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `parent` value format is described below: * - /// [`projects.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): + /// [projects.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create): /// `projects/{PROJECT_ID}`. This method creates project-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * - /// [`organizations.roles.create()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): + /// [organizations.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/create): /// `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are @@ -5509,15 +5508,15 @@ protected override void InitParameters() /// /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `name` value format is described below: * - /// [`projects.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `name` value format is described below: * + /// [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): + /// [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -5548,15 +5547,15 @@ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `name` value format is described below: * - /// [`projects.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): + /// [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.delete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): + /// [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -5605,20 +5604,20 @@ protected override void InitParameters() /// Gets the definition of a Role. /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `name` value format is described below: * - /// [`roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. - /// This method returns results from all [predefined + /// [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `name` value format is described below: * + /// [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This + /// method returns results from all [predefined /// roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request /// URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * - /// [`projects.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): + /// [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): + /// [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -5642,20 +5641,20 @@ public GetRequest(Google.Apis.Services.IClientService service, string name) : ba /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `name` value format is described below: * - /// [`roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. + /// [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. /// This method returns results from all [predefined /// roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example /// request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * - /// [`projects.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): + /// [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): + /// [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -5695,19 +5694,19 @@ protected override void InitParameters() /// /// /// The `parent` parameter's value depends on the target resource for the request, namely - /// [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `parent` value format is described below: * - /// [`roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This + /// [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `parent` value format is described below: * + /// [roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This /// method doesn't require a resource; it simply returns all [predefined /// roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request /// URL: `https://iam.googleapis.com/v1/roles` * - /// [`projects.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): + /// [projects.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): /// `projects/{PROJECT_ID}`. This method lists all project-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * - /// [`organizations.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): + /// [organizations.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): /// `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are @@ -5733,19 +5732,19 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) : /// /// The `parent` parameter's value depends on the target resource for the request, namely - /// [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `parent` value format is described below: * - /// [`roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. - /// This method doesn't require a resource; it simply returns all [predefined + /// [roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This + /// method doesn't require a resource; it simply returns all [predefined /// roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example /// request URL: `https://iam.googleapis.com/v1/roles` * - /// [`projects.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): + /// [projects.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): /// `projects/{PROJECT_ID}`. This method lists all project-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * - /// [`organizations.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): + /// [organizations.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): /// `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are @@ -5853,15 +5852,15 @@ protected override void InitParameters() /// The body of the request. /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `name` value format is described below: * - /// [`projects.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `name` value format is described below: * + /// [projects.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): + /// [organizations.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -5886,15 +5885,15 @@ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Iam /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `name` value format is described below: * - /// [`projects.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): + /// [projects.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/patch): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.patch()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): + /// [organizations.roles.patch](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/patch): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -5950,15 +5949,15 @@ protected override void InitParameters() /// The body of the request. /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `name` value format is described below: * - /// [`projects.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `name` value format is described below: * + /// [projects.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): + /// [organizations.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -5983,15 +5982,15 @@ public UndeleteRequest(Google.Apis.Services.IClientService service, Google.Apis. /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each /// resource type's `name` value format is described below: * - /// [`projects.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): + /// [projects.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.undelete()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): + /// [organizations.roles.undelete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/undelete): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -7101,7 +7100,7 @@ protected override void InitParameters() /// granted any roles on other resources. To check whether a service account has role grants on a resource, /// use the `getIamPolicy` method for that resource. For example, to view the role grants for a project, /// call the Resource Manager API's - /// [`projects.getIamPolicy`](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy) + /// [projects.getIamPolicy](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy) /// method. /// /// @@ -7119,7 +7118,7 @@ public virtual GetIamPolicyRequest GetIamPolicy(string resource) /// granted any roles on other resources. To check whether a service account has role grants on a resource, /// use the `getIamPolicy` method for that resource. For example, to view the role grants for a project, /// call the Resource Manager API's - /// [`projects.getIamPolicy`](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy) + /// [projects.getIamPolicy](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy) /// method. /// public class GetIamPolicyRequest : IamBaseServiceRequest @@ -7418,7 +7417,7 @@ protected override void InitParameters() /// /// **Note:** This method is deprecated. Use the - /// [`signBlob`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) + /// [signBlob](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) /// method in the IAM Service Account Credentials API instead. If you currently use this method, see the /// [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a /// blob using the system-managed private key for a ServiceAccount. @@ -7442,7 +7441,7 @@ public virtual SignBlobRequest SignBlob(Google.Apis.Iam.v1.Data.SignBlobRequest /// /// **Note:** This method is deprecated. Use the - /// [`signBlob`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) + /// [signBlob](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) /// method in the IAM Service Account Credentials API instead. If you currently use this method, see the /// [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a /// blob using the system-managed private key for a ServiceAccount. @@ -7503,10 +7502,10 @@ protected override void InitParameters() /// /// **Note:** This method is deprecated. Use the - /// [`signJwt`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) - /// method in the IAM Service Account Credentials API instead. If you currently use this method, see the - /// [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a - /// JSON Web Token (JWT) using the system-managed private key for a ServiceAccount. + /// [signJwt](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) method + /// in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration + /// guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a JSON Web + /// Token (JWT) using the system-managed private key for a ServiceAccount. /// /// The body of the request. /// @@ -7527,10 +7526,10 @@ public virtual SignJwtRequest SignJwt(Google.Apis.Iam.v1.Data.SignJwtRequest bod /// /// **Note:** This method is deprecated. Use the - /// [`signJwt`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) - /// method in the IAM Service Account Credentials API instead. If you currently use this method, see the - /// [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a - /// JSON Web Token (JWT) using the system-managed private key for a ServiceAccount. + /// [signJwt](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) method + /// in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration + /// guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a JSON Web + /// Token (JWT) using the system-managed private key for a ServiceAccount. /// public class SignJwtRequest : IamBaseServiceRequest { @@ -7823,19 +7822,19 @@ public RolesResource(Google.Apis.Services.IClientService service) /// Gets the definition of a Role. /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource /// type's `name` value format is described below: * - /// [`roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This - /// method returns results from all [predefined + /// [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method + /// returns results from all [predefined /// roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request URL: /// `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * - /// [`projects.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): + /// [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project /// level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): + /// [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -7859,20 +7858,20 @@ public GetRequest(Google.Apis.Services.IClientService service, string name) : ba /// /// The `name` parameter's value depends on the target resource for the request, namely - /// [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `name` value format is described below: * - /// [`roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. - /// This method returns results from all [predefined + /// [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `name` value format is described below: * + /// [roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This + /// method returns results from all [predefined /// roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request /// URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * - /// [`projects.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): + /// [projects.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get): /// `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// project level. Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * - /// [`organizations.roles.get()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): + /// [organizations.roles.get](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/get): /// `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the /// organization level. Example request URL: @@ -7940,19 +7939,19 @@ public ListRequest(Google.Apis.Services.IClientService service) : base(service) /// /// The `parent` parameter's value depends on the target resource for the request, namely - /// [`roles`](https://cloud.google.com/iam/docs/reference/rest/v1/roles), - /// [`projects`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or - /// [`organizations`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each - /// resource type's `parent` value format is described below: * - /// [`roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This + /// [roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), + /// [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles), or + /// [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource + /// type's `parent` value format is described below: * + /// [roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/roles/list): An empty string. This /// method doesn't require a resource; it simply returns all [predefined /// roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) in IAM. Example request /// URL: `https://iam.googleapis.com/v1/roles` * - /// [`projects.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): + /// [projects.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/list): /// `projects/{PROJECT_ID}`. This method lists all project-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * - /// [`organizations.roles.list()`](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): + /// [organizations.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/list): /// `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom /// roles](https://cloud.google.com/iam/docs/understanding-custom-roles). Example request URL: /// `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are @@ -8878,7 +8877,7 @@ public class LintResult : Google.Apis.Requests.IDirectResponseSchema /// Response message for ListOauthClientCredentials. public class ListOauthClientCredentialsResponse : Google.Apis.Requests.IDirectResponseSchema { - /// A list of oauth client credentials. + /// A list of OauthClientCredentials. [Newtonsoft.Json.JsonPropertyAttribute("oauthClientCredentials")] public virtual System.Collections.Generic.IList OauthClientCredentials { get; set; } @@ -8896,7 +8895,7 @@ public class ListOauthClientsResponse : Google.Apis.Requests.IDirectResponseSche [Newtonsoft.Json.JsonPropertyAttribute("nextPageToken")] public virtual string NextPageToken { get; set; } - /// A list of oauth clients. + /// A list of OauthClients. [Newtonsoft.Json.JsonPropertyAttribute("oauthClients")] public virtual System.Collections.Generic.IList OauthClients { get; set; } @@ -9056,12 +9055,12 @@ public class ListWorkloadIdentityPoolsResponse : Google.Apis.Requests.IDirectRes } /// - /// Represents an oauth client. Used to access Google Cloud resources on behave of a user by using OAuth2 Protocol + /// Represents an OauthClient. Used to access Google Cloud resources on behave of a user by using OAuth 2.0 Protocol /// to obtain an access token from Google Cloud Platform. /// public class OauthClient : Google.Apis.Requests.IDirectResponseSchema { - /// Required. The list of OAuth grant type is allowed for the oauth client. + /// Required. The list of OAuth grant types is allowed for the OauthClient. [Newtonsoft.Json.JsonPropertyAttribute("allowedGrantTypes")] public virtual System.Collections.Generic.IList AllowedGrantTypes { get; set; } @@ -9073,7 +9072,7 @@ public class OauthClient : Google.Apis.Requests.IDirectResponseSchema public virtual System.Collections.Generic.IList AllowedRedirectUris { get; set; } /// - /// Required. The list of scopes that the oauth client is allowed to request during OAuth flows. The following + /// Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following /// scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete /// your Google Cloud data and see the email address for your Google Account. * `openid`: Associate you with /// your personal info on Google Cloud. * `email`: See your Google Cloud Account email address. @@ -9081,25 +9080,26 @@ public class OauthClient : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("allowedScopes")] public virtual System.Collections.Generic.IList AllowedScopes { get; set; } - /// Output only. The system-generated oauth client id. + /// Output only. The system-generated OauthClient id. [Newtonsoft.Json.JsonPropertyAttribute("clientId")] public virtual string ClientId { get; set; } - /// Immutable. The type of oauth client. either public or private. + /// + /// Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be + /// managed using the dedicated OauthClientCredential resource. + /// [Newtonsoft.Json.JsonPropertyAttribute("clientType")] public virtual string ClientType { get; set; } - /// Optional. A user-specified description of the oauth client. Cannot exceed 256 characters. + /// Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters. [Newtonsoft.Json.JsonPropertyAttribute("description")] public virtual string Description { get; set; } - /// - /// Optional. Whether the oauth client is disabled. You cannot use a disabled oauth client for login. - /// + /// Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client. [Newtonsoft.Json.JsonPropertyAttribute("disabled")] public virtual System.Nullable Disabled { get; set; } - /// Optional. A user-specified display name of the oauth client. Cannot exceed 32 characters. + /// Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters. [Newtonsoft.Json.JsonPropertyAttribute("displayName")] public virtual string DisplayName { get; set; } @@ -9108,7 +9108,7 @@ public class OauthClient : Google.Apis.Requests.IDirectResponseSchema private object _expireTime; /// - /// Output only. Time after which the oauth client will be permanently purged and cannot be recovered. + /// Output only. Time after which the OauthClient will be permanently purged and cannot be recovered. /// [Newtonsoft.Json.JsonPropertyAttribute("expireTime")] public virtual string ExpireTimeRaw @@ -9143,13 +9143,13 @@ public virtual object ExpireTime } /// - /// Immutable. The resource name of the oauth client. + /// Immutable. The resource name of the OauthClient. /// Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`. /// [Newtonsoft.Json.JsonPropertyAttribute("name")] public virtual string Name { get; set; } - /// Output only. The state of the oauth client. + /// Output only. The state of the OauthClient. [Newtonsoft.Json.JsonPropertyAttribute("state")] public virtual string State { get; set; } @@ -9158,30 +9158,34 @@ public virtual object ExpireTime } /// - /// Represents an oauth client credential. Used to authenticate an oauth client while accessing Google Cloud - /// resources on behalf of a user by using OAuth2 Protocol. + /// Represents an OauthClientCredential. Used to authenticate an OauthClient while accessing Google Cloud resources + /// on behalf of a user by using OAuth 2.0 Protocol. /// public class OauthClientCredential : Google.Apis.Requests.IDirectResponseSchema { - /// Output only. The system-generated oauth client secret. + /// + /// Output only. The system-generated OAuth client secret. The client secret must be stored securely. If the + /// client secret is leaked, you must delete and re-create the client credential. To learn more, see [OAuth + /// client and credential security risks and + /// mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security) + /// [Newtonsoft.Json.JsonPropertyAttribute("clientSecret")] public virtual string ClientSecret { get; set; } /// - /// Optional. Whether the oauth client credential is disabled. You cannot use a disabled oauth client credential - /// for OAuth. + /// Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential. /// [Newtonsoft.Json.JsonPropertyAttribute("disabled")] public virtual System.Nullable Disabled { get; set; } /// - /// Optional. A user-specified display name of the oauth client credential Cannot exceed 32 characters. + /// Optional. A user-specified display name of the OauthClientCredential. Cannot exceed 32 characters. /// [Newtonsoft.Json.JsonPropertyAttribute("displayName")] public virtual string DisplayName { get; set; } /// - /// Immutable. The resource name of the oauth client credential. Format: + /// Immutable. The resource name of the OauthClientCredential. Format: /// `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}` /// [Newtonsoft.Json.JsonPropertyAttribute("name")] diff --git a/Src/Generated/Google.Apis.Iam.v1/Google.Apis.Iam.v1.csproj b/Src/Generated/Google.Apis.Iam.v1/Google.Apis.Iam.v1.csproj index 42c6821865..726865f9ef 100644 --- a/Src/Generated/Google.Apis.Iam.v1/Google.Apis.Iam.v1.csproj +++ b/Src/Generated/Google.Apis.Iam.v1/Google.Apis.Iam.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.Iam.v1 Client Library - 1.68.0.3409 + 1.68.0.3428 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.MapsPlaces.v1/Google.Apis.MapsPlaces.v1.cs b/Src/Generated/Google.Apis.MapsPlaces.v1/Google.Apis.MapsPlaces.v1.cs index 155846b60c..07321f9fd9 100644 --- a/Src/Generated/Google.Apis.MapsPlaces.v1/Google.Apis.MapsPlaces.v1.cs +++ b/Src/Generated/Google.Apis.MapsPlaces.v1/Google.Apis.MapsPlaces.v1.cs @@ -723,10 +723,10 @@ public class GoogleMapsPlacesV1AutocompletePlacesRequest : Google.Apis.Requests. public virtual System.Nullable IncludeQueryPredictions { get; set; } /// - /// Optional. Included primary Place type (for example, "restaurant" or "gas_station") from - /// https://developers.google.com/maps/documentation/places/web-service/place-types. A Place is only returned if - /// its primary type is included in this list. Up to 5 values can be specified. If no types are specified, all - /// Place types are returned. + /// Optional. Included primary Place type (for example, "restaurant" or "gas_station") in Place Types + /// (https://developers.google.com/maps/documentation/places/web-service/place-types), or only `(regions)`, or + /// only `(cities)`. A Place is only returned if its primary type is included in this list. Up to 5 values can + /// be specified. If no types are specified, all Place types are returned. /// [Newtonsoft.Json.JsonPropertyAttribute("includedPrimaryTypes")] public virtual System.Collections.Generic.IList IncludedPrimaryTypes { get; set; } diff --git a/Src/Generated/Google.Apis.MapsPlaces.v1/Google.Apis.MapsPlaces.v1.csproj b/Src/Generated/Google.Apis.MapsPlaces.v1/Google.Apis.MapsPlaces.v1.csproj index f2677d0283..f0e0571d32 100644 --- a/Src/Generated/Google.Apis.MapsPlaces.v1/Google.Apis.MapsPlaces.v1.csproj +++ b/Src/Generated/Google.Apis.MapsPlaces.v1/Google.Apis.MapsPlaces.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.MapsPlaces.v1 Client Library - 1.68.0.3419 + 1.68.0.3428 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.MigrationCenterAPI.v1/Google.Apis.MigrationCenterAPI.v1.cs b/Src/Generated/Google.Apis.MigrationCenterAPI.v1/Google.Apis.MigrationCenterAPI.v1.cs index 0087bc68fc..26122df79b 100644 --- a/Src/Generated/Google.Apis.MigrationCenterAPI.v1/Google.Apis.MigrationCenterAPI.v1.cs +++ b/Src/Generated/Google.Apis.MigrationCenterAPI.v1/Google.Apis.MigrationCenterAPI.v1.cs @@ -5515,7 +5515,7 @@ public class AssetList : Google.Apis.Requests.IDirectResponseSchema public class AssetPerformanceData : Google.Apis.Requests.IDirectResponseSchema { /// - /// Daily resource usage aggregations. Contains all of the data available for an asset, up to the last 40 days. + /// 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. /// [Newtonsoft.Json.JsonPropertyAttribute("dailyResourceUsageAggregations")] diff --git a/Src/Generated/Google.Apis.MigrationCenterAPI.v1/Google.Apis.MigrationCenterAPI.v1.csproj b/Src/Generated/Google.Apis.MigrationCenterAPI.v1/Google.Apis.MigrationCenterAPI.v1.csproj index a3457b3a33..eab43adc87 100644 --- a/Src/Generated/Google.Apis.MigrationCenterAPI.v1/Google.Apis.MigrationCenterAPI.v1.csproj +++ b/Src/Generated/Google.Apis.MigrationCenterAPI.v1/Google.Apis.MigrationCenterAPI.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.MigrationCenterAPI.v1 Client Library - 1.68.0.3409 + 1.68.0.3423 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.MigrationCenterAPI.v1alpha1/Google.Apis.MigrationCenterAPI.v1alpha1.cs b/Src/Generated/Google.Apis.MigrationCenterAPI.v1alpha1/Google.Apis.MigrationCenterAPI.v1alpha1.cs index f8716cd2a4..d37c34faf5 100644 --- a/Src/Generated/Google.Apis.MigrationCenterAPI.v1alpha1/Google.Apis.MigrationCenterAPI.v1alpha1.cs +++ b/Src/Generated/Google.Apis.MigrationCenterAPI.v1alpha1/Google.Apis.MigrationCenterAPI.v1alpha1.cs @@ -5604,7 +5604,7 @@ public class AssetList : Google.Apis.Requests.IDirectResponseSchema public class AssetPerformanceData : Google.Apis.Requests.IDirectResponseSchema { /// - /// Daily resource usage aggregations. Contains all of the data available for an asset, up to the last 40 days. + /// 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. /// [Newtonsoft.Json.JsonPropertyAttribute("dailyResourceUsageAggregations")] diff --git a/Src/Generated/Google.Apis.MigrationCenterAPI.v1alpha1/Google.Apis.MigrationCenterAPI.v1alpha1.csproj b/Src/Generated/Google.Apis.MigrationCenterAPI.v1alpha1/Google.Apis.MigrationCenterAPI.v1alpha1.csproj index 3450b0771f..311293a13b 100644 --- a/Src/Generated/Google.Apis.MigrationCenterAPI.v1alpha1/Google.Apis.MigrationCenterAPI.v1alpha1.csproj +++ b/Src/Generated/Google.Apis.MigrationCenterAPI.v1alpha1/Google.Apis.MigrationCenterAPI.v1alpha1.csproj @@ -3,7 +3,7 @@ Google.Apis.MigrationCenterAPI.v1alpha1 Client Library - 1.68.0.3416 + 1.68.0.3423 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.NetworkManagement.v1/Google.Apis.NetworkManagement.v1.cs b/Src/Generated/Google.Apis.NetworkManagement.v1/Google.Apis.NetworkManagement.v1.cs index b92c03461d..0717e8ac5d 100644 --- a/Src/Generated/Google.Apis.NetworkManagement.v1/Google.Apis.NetworkManagement.v1.cs +++ b/Src/Generated/Google.Apis.NetworkManagement.v1/Google.Apis.NetworkManagement.v1.cs @@ -1901,10 +1901,18 @@ public class DeliverInfo : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("ipAddress")] public virtual string IpAddress { get; set; } + /// PSC Google API target the packet is delivered to (if applicable). + [Newtonsoft.Json.JsonPropertyAttribute("pscGoogleApiTarget")] + public virtual string PscGoogleApiTarget { get; set; } + /// URI of the resource that the packet is delivered to. [Newtonsoft.Json.JsonPropertyAttribute("resourceUri")] public virtual string ResourceUri { get; set; } + /// Name of the Cloud Storage Bucket the packet is delivered to (if applicable). + [Newtonsoft.Json.JsonPropertyAttribute("storageBucket")] + public virtual string StorageBucket { get; set; } + /// Target type where the packet is delivered to. [Newtonsoft.Json.JsonPropertyAttribute("target")] public virtual string Target { get; set; } @@ -2230,27 +2238,46 @@ public class ForwardInfo : Google.Apis.Requests.IDirectResponseSchema /// For display only. Metadata associated with a Compute Engine forwarding rule. public class ForwardingRuleInfo : Google.Apis.Requests.IDirectResponseSchema { - /// Name of a Compute Engine forwarding rule. + /// Name of the forwarding rule. [Newtonsoft.Json.JsonPropertyAttribute("displayName")] public virtual string DisplayName { get; set; } - /// Port range defined in the forwarding rule that matches the test. + /// + /// Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load + /// balancers (like PSC forwarding rules). + /// + [Newtonsoft.Json.JsonPropertyAttribute("loadBalancerName")] + public virtual string LoadBalancerName { get; set; } + + /// Port range defined in the forwarding rule that matches the packet. [Newtonsoft.Json.JsonPropertyAttribute("matchedPortRange")] public virtual string MatchedPortRange { get; set; } - /// Protocol defined in the forwarding rule that matches the test. + /// Protocol defined in the forwarding rule that matches the packet. [Newtonsoft.Json.JsonPropertyAttribute("matchedProtocol")] public virtual string MatchedProtocol { get; set; } - /// Network URI. Only valid for Internal Load Balancer. + /// Network URI. [Newtonsoft.Json.JsonPropertyAttribute("networkUri")] public virtual string NetworkUri { get; set; } + /// PSC Google API target this forwarding rule targets (if applicable). + [Newtonsoft.Json.JsonPropertyAttribute("pscGoogleApiTarget")] + public virtual string PscGoogleApiTarget { get; set; } + + /// URI of the PSC service attachment this forwarding rule targets (if applicable). + [Newtonsoft.Json.JsonPropertyAttribute("pscServiceAttachmentUri")] + public virtual string PscServiceAttachmentUri { get; set; } + + /// Region of the forwarding rule. Set only for regional forwarding rules. + [Newtonsoft.Json.JsonPropertyAttribute("region")] + public virtual string Region { get; set; } + /// Target type of the forwarding rule. [Newtonsoft.Json.JsonPropertyAttribute("target")] public virtual string Target { get; set; } - /// URI of a Compute Engine forwarding rule. + /// URI of the forwarding rule. [Newtonsoft.Json.JsonPropertyAttribute("uri")] public virtual string Uri { get; set; } @@ -3144,6 +3171,17 @@ public class RouteInfo : Google.Apis.Requests.IDirectResponseSchema public virtual string ETag { get; set; } } + /// For display only. Metadata associated with the serverless network endpoint group backend. + public class ServerlessNegInfo : Google.Apis.Requests.IDirectResponseSchema + { + /// URI of the serverless network endpoint group. + [Newtonsoft.Json.JsonPropertyAttribute("negUri")] + public virtual string NegUri { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + /// Request message for `SetIamPolicy` method. public class SetIamPolicyRequest : Google.Apis.Requests.IDirectResponseSchema { @@ -3300,6 +3338,12 @@ public class Step : Google.Apis.Requests.IDirectResponseSchema [Newtonsoft.Json.JsonPropertyAttribute("route")] public virtual RouteInfo Route { get; set; } + /// + /// Display information of a Serverless network endpoint group backend. Used only for return traces. + /// + [Newtonsoft.Json.JsonPropertyAttribute("serverlessNeg")] + public virtual ServerlessNegInfo ServerlessNeg { get; set; } + /// Each step is in one of the pre-defined states. [Newtonsoft.Json.JsonPropertyAttribute("state")] public virtual string State { get; set; } diff --git a/Src/Generated/Google.Apis.NetworkManagement.v1/Google.Apis.NetworkManagement.v1.csproj b/Src/Generated/Google.Apis.NetworkManagement.v1/Google.Apis.NetworkManagement.v1.csproj index df70ec5e46..8d798dec86 100644 --- a/Src/Generated/Google.Apis.NetworkManagement.v1/Google.Apis.NetworkManagement.v1.csproj +++ b/Src/Generated/Google.Apis.NetworkManagement.v1/Google.Apis.NetworkManagement.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.NetworkManagement.v1 Client Library - 1.68.0.3401 + 1.68.0.3422 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.RecaptchaEnterprise.v1/Google.Apis.RecaptchaEnterprise.v1.cs b/Src/Generated/Google.Apis.RecaptchaEnterprise.v1/Google.Apis.RecaptchaEnterprise.v1.cs index 97be037d98..174b7d2135 100644 --- a/Src/Generated/Google.Apis.RecaptchaEnterprise.v1/Google.Apis.RecaptchaEnterprise.v1.cs +++ b/Src/Generated/Google.Apis.RecaptchaEnterprise.v1/Google.Apis.RecaptchaEnterprise.v1.cs @@ -1771,6 +1771,13 @@ public class GoogleCloudRecaptchaenterpriseV1Assessment : Google.Apis.Requests.I [Newtonsoft.Json.JsonPropertyAttribute("name")] public virtual string Name { get; set; } + /// + /// Output only. Assessment returned when a site key, a token, and a phone number as `user_id` are provided. + /// Account defender and SMS toll fraud protection need to be enabled. + /// + [Newtonsoft.Json.JsonPropertyAttribute("phoneFraudAssessment")] + public virtual GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment PhoneFraudAssessment { get; set; } + /// /// Optional. The private password leak verification field contains the parameters that are used to to check for /// leaks privately without sharing user credentials. @@ -2535,6 +2542,17 @@ public class GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest : Google.Apis.Req public virtual string ETag { get; set; } } + /// Assessment for Phone Fraud + public class GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment : Google.Apis.Requests.IDirectResponseSchema + { + /// Output only. Assessment of this phone event for risk of sms toll fraud. + [Newtonsoft.Json.JsonPropertyAttribute("smsTollFraudVerdict")] + public virtual GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict SmsTollFraudVerdict { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + /// Private password leak verification info. public class GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification : Google.Apis.Requests.IDirectResponseSchema { @@ -2766,6 +2784,23 @@ public class GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembership public virtual string ETag { get; set; } } + /// Information about sms toll fraud + public class GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict : Google.Apis.Requests.IDirectResponseSchema + { + /// Output only. Reasons contributing to the SMS toll fraud verdict. + [Newtonsoft.Json.JsonPropertyAttribute("reasons")] + public virtual System.Collections.Generic.IList Reasons { get; set; } + + /// + /// Output only. Probability of an sms event being fraudulent. Values are from 0.0 (lowest) to 1.0 (highest). + /// + [Newtonsoft.Json.JsonPropertyAttribute("risk")] + public virtual System.Nullable Risk { get; set; } + + /// The ETag of the item. + public virtual string ETag { get; set; } + } + /// Options for user acceptance testing. public class GoogleCloudRecaptchaenterpriseV1TestingOptions : Google.Apis.Requests.IDirectResponseSchema { diff --git a/Src/Generated/Google.Apis.RecaptchaEnterprise.v1/Google.Apis.RecaptchaEnterprise.v1.csproj b/Src/Generated/Google.Apis.RecaptchaEnterprise.v1/Google.Apis.RecaptchaEnterprise.v1.csproj index bd6fe98392..e09a00b249 100644 --- a/Src/Generated/Google.Apis.RecaptchaEnterprise.v1/Google.Apis.RecaptchaEnterprise.v1.csproj +++ b/Src/Generated/Google.Apis.RecaptchaEnterprise.v1/Google.Apis.RecaptchaEnterprise.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.RecaptchaEnterprise.v1 Client Library - 1.68.0.3370 + 1.68.0.3425 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.ServiceNetworking.v1/Google.Apis.ServiceNetworking.v1.cs b/Src/Generated/Google.Apis.ServiceNetworking.v1/Google.Apis.ServiceNetworking.v1.cs index 74b63da44b..1c04f1bd65 100644 --- a/Src/Generated/Google.Apis.ServiceNetworking.v1/Google.Apis.ServiceNetworking.v1.cs +++ b/Src/Generated/Google.Apis.ServiceNetworking.v1/Google.Apis.ServiceNetworking.v1.cs @@ -5168,7 +5168,8 @@ public class PolicyBinding : Google.Apis.Requests.IDirectResponseSchema /// 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/compute.xpnAdmin' applied on the shared VPC host project - - /// 'roles/dns.admin' 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 /// [Newtonsoft.Json.JsonPropertyAttribute("role")] public virtual string Role { get; set; } diff --git a/Src/Generated/Google.Apis.ServiceNetworking.v1/Google.Apis.ServiceNetworking.v1.csproj b/Src/Generated/Google.Apis.ServiceNetworking.v1/Google.Apis.ServiceNetworking.v1.csproj index 144e988ef6..fe494ab463 100644 --- a/Src/Generated/Google.Apis.ServiceNetworking.v1/Google.Apis.ServiceNetworking.v1.csproj +++ b/Src/Generated/Google.Apis.ServiceNetworking.v1/Google.Apis.ServiceNetworking.v1.csproj @@ -3,7 +3,7 @@ Google.Apis.ServiceNetworking.v1 Client Library - 1.68.0.3401 + 1.68.0.3428 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.ServiceNetworking.v1beta/Google.Apis.ServiceNetworking.v1beta.cs b/Src/Generated/Google.Apis.ServiceNetworking.v1beta/Google.Apis.ServiceNetworking.v1beta.cs index 47795a8b4f..4a609f6b1f 100644 --- a/Src/Generated/Google.Apis.ServiceNetworking.v1beta/Google.Apis.ServiceNetworking.v1beta.cs +++ b/Src/Generated/Google.Apis.ServiceNetworking.v1beta/Google.Apis.ServiceNetworking.v1beta.cs @@ -3072,7 +3072,8 @@ public class PolicyBinding : Google.Apis.Requests.IDirectResponseSchema /// 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/compute.xpnAdmin' applied on the shared VPC host project - - /// 'roles/dns.admin' 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 /// [Newtonsoft.Json.JsonPropertyAttribute("role")] public virtual string Role { get; set; } diff --git a/Src/Generated/Google.Apis.ServiceNetworking.v1beta/Google.Apis.ServiceNetworking.v1beta.csproj b/Src/Generated/Google.Apis.ServiceNetworking.v1beta/Google.Apis.ServiceNetworking.v1beta.csproj index 6077d46467..537b2fe939 100644 --- a/Src/Generated/Google.Apis.ServiceNetworking.v1beta/Google.Apis.ServiceNetworking.v1beta.csproj +++ b/Src/Generated/Google.Apis.ServiceNetworking.v1beta/Google.Apis.ServiceNetworking.v1beta.csproj @@ -3,7 +3,7 @@ Google.Apis.ServiceNetworking.v1beta Client Library - 1.68.0.3401 + 1.68.0.3428 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.Sheets.v4/Google.Apis.Sheets.v4.cs b/Src/Generated/Google.Apis.Sheets.v4/Google.Apis.Sheets.v4.cs index 169cfdb3b4..99e1997584 100644 --- a/Src/Generated/Google.Apis.Sheets.v4/Google.Apis.Sheets.v4.cs +++ b/Src/Generated/Google.Apis.Sheets.v4/Google.Apis.Sheets.v4.cs @@ -6751,7 +6751,7 @@ public class RandomizeRangeRequest : Google.Apis.Requests.IDirectResponseSchema } /// - /// The status of a refresh cancellation. You can send cancel request to explicitly cancel one or multiple data + /// The status of a refresh cancellation. You can send a cancel request to explicitly cancel one or multiple data /// source object refreshes. /// public class RefreshCancellationStatus : Google.Apis.Requests.IDirectResponseSchema diff --git a/Src/Generated/Google.Apis.Sheets.v4/Google.Apis.Sheets.v4.csproj b/Src/Generated/Google.Apis.Sheets.v4/Google.Apis.Sheets.v4.csproj index 123dba6e88..53c42ff823 100644 --- a/Src/Generated/Google.Apis.Sheets.v4/Google.Apis.Sheets.v4.csproj +++ b/Src/Generated/Google.Apis.Sheets.v4/Google.Apis.Sheets.v4.csproj @@ -3,7 +3,7 @@ Google.Apis.Sheets.v4 Client Library - 1.68.0.3407 + 1.68.0.3421 Google LLC Copyright 2024 Google LLC Google diff --git a/Src/Generated/Google.Apis.ShoppingContent.v2_1/Google.Apis.ShoppingContent.v2_1.cs b/Src/Generated/Google.Apis.ShoppingContent.v2_1/Google.Apis.ShoppingContent.v2_1.cs index a3f977f57f..5660344602 100644 --- a/Src/Generated/Google.Apis.ShoppingContent.v2_1/Google.Apis.ShoppingContent.v2_1.cs +++ b/Src/Generated/Google.Apis.ShoppingContent.v2_1/Google.Apis.ShoppingContent.v2_1.cs @@ -18626,19 +18626,20 @@ public class MethodQuota : Google.Apis.Requests.IDirectResponseSchema public class Metrics : Google.Apis.Requests.IDirectResponseSchema { /// - /// Average order size - the average number of items in an order. **This metric cannot be segmented by product + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average + /// order size - the average number of items in an order. **This metric cannot be segmented by product /// dimensions and customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("aos")] public virtual System.Nullable Aos { get; set; } /// - /// Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value - /// (total price of items) of all placed orders. The currency of the returned value is stored in the - /// currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the - /// SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code - /// segment is populated in the response. **This metric cannot be segmented by product dimensions and - /// customer_country_code.** + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average + /// order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value (total + /// price of items) of all placed orders. The currency of the returned value is stored in the currency_code + /// segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in + /// the search query (unless it is explicitly selected by the user) and the currency_code segment is populated + /// in the response. **This metric cannot be segmented by product dimensions and customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("aovMicros")] public virtual System.Nullable AovMicros { get; set; } @@ -18649,7 +18650,7 @@ public class Metrics : Google.Apis.Requests.IDirectResponseSchema /// /// Number of conversions divided by the number of clicks, reported on the impression date. The metric is - /// currently available only for the FREE_PRODUCT_LISTING program. + /// currently available only for the `FREE_PRODUCT_LISTING` program. /// [Newtonsoft.Json.JsonPropertyAttribute("conversionRate")] public virtual System.Nullable ConversionRate { get; set; } @@ -18657,10 +18658,10 @@ public class Metrics : Google.Apis.Requests.IDirectResponseSchema /// /// Value of conversions in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) attributed to the /// product, reported on the conversion date. The metric is currently available only for the - /// FREE_PRODUCT_LISTING program. The currency of the returned value is stored in the currency_code segment. If - /// this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search - /// query (unless it is explicitly selected by the user) and the currency_code segment is populated in the - /// response. + /// `FREE_PRODUCT_LISTING` program. The currency of the returned value is stored in the currency_code segment. + /// If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the + /// search query (unless it is explicitly selected by the user) and the currency_code segment is populated in + /// the response. /// [Newtonsoft.Json.JsonPropertyAttribute("conversionValueMicros")] public virtual System.Nullable ConversionValueMicros { get; set; } @@ -18669,7 +18670,7 @@ public class Metrics : Google.Apis.Requests.IDirectResponseSchema /// Number of conversions attributed to the product, reported on the conversion date. Depending on the /// attribution model, a conversion might be distributed across multiple clicks, where each click gets its own /// credit assigned. This metric is a sum of all such credits. The metric is currently available only for the - /// FREE_PRODUCT_LISTING program. + /// `FREE_PRODUCT_LISTING` program. /// [Newtonsoft.Json.JsonPropertyAttribute("conversions")] public virtual System.Nullable Conversions { get; set; } @@ -18682,7 +18683,8 @@ public class Metrics : Google.Apis.Requests.IDirectResponseSchema public virtual System.Nullable Ctr { get; set; } /// - /// Average number of days between an order being placed and the order being fully shipped, reported on the last + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average + /// number of days between an order being placed and the order being fully shipped, reported on the last /// shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("daysToShip")] @@ -18693,13 +18695,15 @@ public class Metrics : Google.Apis.Requests.IDirectResponseSchema public virtual System.Nullable Impressions { get; set; } /// - /// Average number of days between an item being ordered and the item being **This metric cannot be segmented by + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average + /// number of days between an item being ordered and the item being **This metric cannot be segmented by /// customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("itemDaysToShip")] public virtual System.Nullable ItemDaysToShip { get; set; } /// + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. /// Percentage of shipped items in relation to all finalized items (shipped or rejected by the merchant; /// unshipped items are not taken into account), reported on the order date. Item fill rate is lowered by /// merchant rejections. **This metric cannot be segmented by customer_country_code.** @@ -18708,7 +18712,8 @@ public class Metrics : Google.Apis.Requests.IDirectResponseSchema public virtual System.Nullable ItemFillRate { get; set; } /// - /// Total price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). Excludes + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total + /// price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). Excludes /// shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. /// The currency of the returned value is stored in the currency_code segment. If this metric is selected, /// 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is @@ -18719,44 +18724,50 @@ public class Metrics : Google.Apis.Requests.IDirectResponseSchema public virtual System.Nullable OrderedItemSalesMicros { get; set; } /// - /// Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the - /// order. **This metric cannot be segmented by customer_country_code.** + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number + /// of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order. + /// **This metric cannot be segmented by customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("orderedItems")] public virtual System.Nullable OrderedItems { get; set; } /// - /// Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the - /// order. **This metric cannot be segmented by product dimensions and customer_country_code.** + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number + /// of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order. + /// **This metric cannot be segmented by product dimensions and customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("orders")] public virtual System.Nullable Orders { get; set; } /// - /// Number of ordered items canceled by the merchant, reported on the order date. **This metric cannot be - /// segmented by customer_country_code.** + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number + /// of ordered items canceled by the merchant, reported on the order date. **This metric cannot be segmented by + /// customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("rejectedItems")] public virtual System.Nullable RejectedItems { get; set; } /// - /// Total price of returned items divided by the total price of shipped items, reported on the order date. If - /// this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search - /// query (unless it is explicitly selected by the user) and the currency_code segment is populated in the - /// response. **This metric cannot be segmented by customer_country_code.** + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total + /// price of returned items divided by the total price of shipped items, reported on the order date. If this + /// metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query + /// (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. + /// **This metric cannot be segmented by customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("returnRate")] public virtual System.Nullable ReturnRate { get; set; } /// - /// Number of ordered items sent back for return, reported on the date when the merchant accepted the return. - /// **This metric cannot be segmented by customer_country_code.** + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number + /// of ordered items sent back for return, reported on the date when the merchant accepted the return. **This + /// metric cannot be segmented by customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("returnedItems")] public virtual System.Nullable ReturnedItems { get; set; } /// - /// Total price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total + /// price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 /// micros), reported on the date when the merchant accepted the return. The currency of the returned value is /// stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically /// added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the @@ -18767,8 +18778,9 @@ public class Metrics : Google.Apis.Requests.IDirectResponseSchema public virtual System.Nullable ReturnsMicros { get; set; } /// - /// Total price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on - /// the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total + /// price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the + /// order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the /// currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the /// SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code /// segment is populated in the response. **This metric cannot be segmented by customer_country_code.** @@ -18777,31 +18789,35 @@ public class Metrics : Google.Apis.Requests.IDirectResponseSchema public virtual System.Nullable ShippedItemSalesMicros { get; set; } /// - /// Number of shipped items, reported on the shipment date. **This metric cannot be segmented by + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number + /// of shipped items, reported on the shipment date. **This metric cannot be segmented by /// customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("shippedItems")] public virtual System.Nullable ShippedItems { get; set; } /// - /// Number of fully shipped orders, reported on the last shipment date. **This metric cannot be segmented by - /// product dimensions and customer_country_code.** + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number + /// of fully shipped orders, reported on the last shipment date. **This metric cannot be segmented by product + /// dimensions and customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("shippedOrders")] public virtual System.Nullable ShippedOrders { get; set; } /// - /// Number of ordered items not shipped up until the end of the queried day. If a multi-day period is specified - /// in the search query, the returned value is the average number of unshipped items over the days in the - /// queried period. **This metric cannot be segmented by customer_country_code.** + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number + /// of ordered items not shipped up until the end of the queried day. If a multi-day period is specified in the + /// search query, the returned value is the average number of unshipped items over the days in the queried + /// period. **This metric cannot be segmented by customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("unshippedItems")] public virtual System.Nullable UnshippedItems { get; set; } /// - /// Number of orders not shipped or partially shipped up until the end of the queried day. If a multi-day period - /// is specified in the search query, the returned value is the average number of unshipped orders over the days - /// in the queried period. **This metric cannot be segmented by product dimensions and customer_country_code.** + /// *Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number + /// of orders not shipped or partially shipped up until the end of the queried day. If a multi-day period is + /// specified in the search query, the returned value is the average number of unshipped orders over the days in + /// the queried period. **This metric cannot be segmented by product dimensions and customer_country_code.** /// [Newtonsoft.Json.JsonPropertyAttribute("unshippedOrders")] public virtual System.Nullable UnshippedOrders { get; set; } @@ -22477,12 +22493,21 @@ public class Product : Google.Apis.Requests.IDirectResponseSchema public virtual string LinkTemplate { get; set; } /// - /// Loyalty program information that is used to surface loyalty benefits ( for example pricing, points, etc) to - /// the user for this item. + /// Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, + /// etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This + /// field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' + /// field below. /// [Newtonsoft.Json.JsonPropertyAttribute("loyaltyProgram")] public virtual LoyaltyProgram LoyaltyProgram { get; set; } + /// + /// Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, + /// better pricing, points, etc) to the user of this item. + /// + [Newtonsoft.Json.JsonPropertyAttribute("loyaltyPrograms")] + public virtual System.Collections.Generic.IList LoyaltyPrograms { get; set; } + /// The material of which the item is made. [Newtonsoft.Json.JsonPropertyAttribute("material")] public virtual string Material { get; set; } diff --git a/Src/Generated/Google.Apis.ShoppingContent.v2_1/Google.Apis.ShoppingContent.v2_1.csproj b/Src/Generated/Google.Apis.ShoppingContent.v2_1/Google.Apis.ShoppingContent.v2_1.csproj index 7a8838c923..f0859efa13 100644 --- a/Src/Generated/Google.Apis.ShoppingContent.v2_1/Google.Apis.ShoppingContent.v2_1.csproj +++ b/Src/Generated/Google.Apis.ShoppingContent.v2_1/Google.Apis.ShoppingContent.v2_1.csproj @@ -3,7 +3,7 @@ Google.Apis.ShoppingContent.v2_1 Client Library - 1.68.0.3421 + 1.68.0.3428 Google LLC Copyright 2024 Google LLC Google