google-api-python-client 2.171.0__py3-none-any.whl → 2.172.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json

@@ -489,7 +489,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
 "required": true,
@@ -601,7 +601,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$",
 "required": true,
@@ -9173,7 +9173,7 @@
 }
 }
 },
-"revision": "20250521",
+"revision": "20250604",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "ApiservingMediaRequestInfo": {
@@ -10281,6 +10281,54 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata": {
+"description": "Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"failureCount": {
+"description": "Count of user licenses that failed to be updated.",
+"format": "int64",
+"type": "string"
+},
+"successCount": {
+"description": "Count of user licenses successfully updated.",
+"format": "int64",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse": {
+"description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.",
+"id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse",
+"properties": {
+"errorSamples": {
+"description": "A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+},
+"userLicenses": {
+"description": "UserLicenses successfully updated.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1UserLicense"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1CmekConfig": {
 "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.",
 "id": "GoogleCloudDiscoveryengineV1CmekConfig",
@@ -10305,7 +10353,7 @@
 "type": "string"
 },
 "name": {
-"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
 "type": "string"
 },
 "notebooklmState": {
@@ -10342,7 +10390,8 @@
 "DELETING",
 "DELETE_FAILED",
 "UNUSABLE",
-"ACTIVE_ROTATING"
+"ACTIVE_ROTATING",
+"DELETED"
 ],
 "enumDescriptions": [
 "The CmekConfig state is unknown.",
@@ -10352,7 +10401,8 @@
 "The CmekConfig is deleting.",
 "The CmekConfig deletion process failed.",
 "The CmekConfig is not usable, most likely due to some internal issue.",
-"The KMS key version is being rotated."
+"The KMS key version is being rotated.",
+"The KMS key is soft deleted. Some cleanup policy will eventually be applied."
 ],
 "readOnly": true,
 "type": "string"
@@ -12645,6 +12695,62 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1UserLicense": {
+"description": "User License information assigned by the admin.",
+"id": "GoogleCloudDiscoveryengineV1UserLicense",
+"properties": {
+"createTime": {
+"description": "Output only. User created timestamp.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"lastLoginTime": {
+"description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"licenseAssignmentState": {
+"description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;",
+"enum": [
+"LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
+"ASSIGNED",
+"UNASSIGNED",
+"NO_LICENSE",
+"NO_LICENSE_ATTEMPTED_LOGIN"
+],
+"enumDescriptions": [
+"Default value.",
+"License assigned to the user.",
+"No license assigned to the user. Deprecated, translated to NO_LICENSE.",
+"No license assigned to the user.",
+"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)."
+],
+"readOnly": true,
+"type": "string"
+},
+"licenseConfig": {
+"description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.",
+"type": "string"
+},
+"updateTime": {
+"description": "Output only. User update timestamp.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"userPrincipal": {
+"description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.",
+"type": "string"
+},
+"userProfile": {
+"description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1WorkspaceConfig": {
 "description": "Config to store data store type configuration for workspace data",
 "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig",
@@ -14604,10 +14710,6 @@
 "description": "Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state.",
 "type": "boolean"
 },
-"gcsSource": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource",
-"description": "Cloud Storage location for the input content."
-},
 "inlineSource": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource",
 "description": "The inline source for the input content for document embeddings."
@@ -15280,7 +15382,7 @@
 "type": "string"
 },
 "name": {
-"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
 "type": "string"
 },
 "notebooklmState": {
@@ -15317,7 +15419,8 @@
 "DELETING",
 "DELETE_FAILED",
 "UNUSABLE",
-"ACTIVE_ROTATING"
+"ACTIVE_ROTATING",
+"DELETED"
 ],
 "enumDescriptions": [
 "The CmekConfig state is unknown.",
@@ -15327,7 +15430,8 @@
 "The CmekConfig is deleting.",
 "The CmekConfig deletion process failed.",
 "The CmekConfig is not usable, most likely due to some internal issue.",
-"The KMS key version is being rotated."
+"The KMS key version is being rotated.",
+"The KMS key is soft deleted. Some cleanup policy will eventually be applied."
 ],
 "readOnly": true,
 "type": "string"
@@ -16488,12 +16592,12 @@
 "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector."
 },
 "incrementalRefreshInterval": {
-"description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days.",
+"description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors.",
 "format": "google-duration",
 "type": "string"
 },
 "incrementalSyncDisabled": {
-"description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled.",
+"description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors.",
 "type": "boolean"
 },
 "kmsKeyName": {
@@ -18044,7 +18148,7 @@
 "properties": {
 "querySetSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec",
-"description": "Required. The specification of the query set."
+"description": "Optional. The specification of the query set."
 },
 "searchRequest": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest",
@@ -18058,7 +18162,7 @@
 "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec",
 "properties": {
 "sampleQuerySet": {
-"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
+"description": "Optional. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
 "type": "string"
 }
 },
@@ -18786,7 +18890,7 @@
 "enumDescriptions": [
 "Defaults to `INCREMENTAL`.",
 "Inserts new documents or updates existing documents.",
-"Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location."
+"Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location. When using this mode, there won't be any downtime on the dataset targeted. Any document that should remain unchanged or that should be updated will continue serving while the operation is running."
 ],
 "type": "string"
 },
@@ -22874,6 +22978,13 @@
 "query": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
 "description": "The user query."
+},
+"queryConfigs": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix \"google.\" will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with \"google..\". 3P services can use anything not starting with \"google.\"",
+"type": "object"
 }
 },
 "type": "object"
@@ -24560,6 +24671,54 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata": {
+"description": "Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"failureCount": {
+"description": "Count of user licenses that failed to be updated.",
+"format": "int64",
+"type": "string"
+},
+"successCount": {
+"description": "Count of user licenses successfully updated.",
+"format": "int64",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse": {
+"description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.",
+"id": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse",
+"properties": {
+"errorSamples": {
+"description": "A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+},
+"userLicenses": {
+"description": "UserLicenses successfully updated.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaUserLicense"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaCmekConfig": {
 "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.",
 "id": "GoogleCloudDiscoveryengineV1betaCmekConfig",
@@ -24584,7 +24743,7 @@
 "type": "string"
 },
 "name": {
-"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
 "type": "string"
 },
 "notebooklmState": {
@@ -24621,7 +24780,8 @@
 "DELETING",
 "DELETE_FAILED",
 "UNUSABLE",
-"ACTIVE_ROTATING"
+"ACTIVE_ROTATING",
+"DELETED"
 ],
 "enumDescriptions": [
 "The CmekConfig state is unknown.",
@@ -24631,7 +24791,8 @@
 "The CmekConfig is deleting.",
 "The CmekConfig deletion process failed.",
 "The CmekConfig is not usable, most likely due to some internal issue.",
-"The KMS key version is being rotated."
+"The KMS key version is being rotated.",
+"The KMS key is soft deleted. Some cleanup policy will eventually be applied."
 ],
 "readOnly": true,
 "type": "string"
@@ -25897,7 +26058,7 @@
 "properties": {
 "querySetSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec",
-"description": "Required. The specification of the query set."
+"description": "Optional. The specification of the query set."
 },
 "searchRequest": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest",
@@ -25911,7 +26072,7 @@
 "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec",
 "properties": {
 "sampleQuerySet": {
-"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
+"description": "Optional. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
 "type": "string"
 }
 },
@@ -27782,6 +27943,62 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaUserLicense": {
+"description": "User License information assigned by the admin.",
+"id": "GoogleCloudDiscoveryengineV1betaUserLicense",
+"properties": {
+"createTime": {
+"description": "Output only. User created timestamp.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"lastLoginTime": {
+"description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"licenseAssignmentState": {
+"description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;",
+"enum": [
+"LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
+"ASSIGNED",
+"UNASSIGNED",
+"NO_LICENSE",
+"NO_LICENSE_ATTEMPTED_LOGIN"
+],
+"enumDescriptions": [
+"Default value.",
+"License assigned to the user.",
+"No license assigned to the user. Deprecated, translated to NO_LICENSE.",
+"No license assigned to the user.",
+"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)."
+],
+"readOnly": true,
+"type": "string"
+},
+"licenseConfig": {
+"description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.",
+"type": "string"
+},
+"updateTime": {
+"description": "Output only. User update timestamp.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"userPrincipal": {
+"description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.",
+"type": "string"
+},
+"userProfile": {
+"description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": {
 "description": "Config to store data store type configuration for workspace data",
 "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig",