Method: projects.locations.dataStores.patch

Actualiza los parámetros de un solo DataStore.

dataStores.patch, dataStores.importDocuments y dataStores.purgeDocuments se ejecutan de a una por DataStore. Mientras se ejecuta una, puede esperar una más; cualquier otra solicitud falla con ABORTED hasta que finalice la operación en ejecución.

Solicitud HTTP

PATCH https://vectorsearch.googleapis.com/v1beta/{dataStore.name}

Parámetros de ruta

Parámetros
dataStore.name

string

Es el identificador. Es el nombre completamente calificado del recurso del DataStore.

Formato: projects/{project}/locations/{location}/dataStores/{dataStoreId}

Parámetros de consulta

Parámetros
updateMask

string (FieldMask format)

Es opcional. La máscara de campo se usa para especificar los campos que la actualización reemplazará en el recurso DataStore. Los campos especificados en updateMask se relacionan con el recurso, no con la solicitud completa. Un campo se reemplazará si está en la máscara. Una ruta que nombra un mensaje reemplaza todo el mensaje: los subcampos omitidos de la solicitud se borran y, en processingConfig, se restablecen a sus valores predeterminados.

Si el usuario no proporciona una máscara, se reemplazan todos los campos que la solicitud establece en un valor no predeterminado. Los mensajes que se envían vacíos (por ejemplo, layoutParsingConfig: {}) y los campos configurados con su valor predeterminado (por ejemplo, false) no se aplican. En su lugar, asígnales un nombre en la máscara.

Los siguientes campos admiten actualizaciones: displayName, description, labels, processingConfig y documentMetadataSchema. documentMetadataSchema debe actualizarse en su totalidad (la ruta de la máscara es documentMetadataSchema) y solo agregando propiedades: las propiedades existentes no se pueden quitar ni cambiar.

Si se proporciona * en updateMask, se realizará un reemplazo completo.

Esta es una lista separada por comas de los nombres de campos completamente calificados. Ejemplo: "user.displayName,photo".
requestId

string

Opcional. Un ID de solicitud opcional para identificar solicitudes. Especifica un ID de solicitud único para que, si debes reintentar la solicitud, el servidor sepa que debe ignorarla si ya se completó. El servidor lo garantizará durante, al menos, 60 minutos después de la primera solicitud.

Por ejemplo, imagina una situación en la que haces una solicitud inicial y se agota el tiempo de espera. Si vuelves a hacer la solicitud con el mismo ID, el servidor puede verificar si se recibió la operación original con el mismo ID y, de ser así, ignorar la segunda solicitud. Esto evita que los clientes creen compromisos duplicados por accidente.

El ID de solicitud debe ser un UUID válido, con la excepción de que no se admite ningún UUID cero (00000000-0000-0000-0000-000000000000).

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de DataStore.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/vectorsearch

Para obtener más información, consulta Authentication Overview.