Method: projects.locations.dataStores.patch

Atualiza os parâmetros de um único DataStore.

dataStores.patch, dataStores.importDocuments e dataStores.purgeDocuments são executados um por vez em cada DataStore. Enquanto uma é executada, outra pode aguardar. Qualquer outra solicitação falha com ABORTED até que a operação em execução seja concluída.

Solicitação HTTP

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

Parâmetros de caminho

Parâmetros
dataStore.name

string

Identificador. O nome totalmente qualificado do recurso do DataStore.

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

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Opcional. A máscara de campo é usada para especificar os campos a serem substituídos no recurso DataStore pela atualização. Os campos especificados em updateMask são relativos ao recurso, não à solicitação completa. Um campo será substituído se estiver na máscara. Um caminho que nomeia uma mensagem substitui toda a mensagem: os subcampos omitidos da solicitação são limpos e, em processingConfig, são redefinidos para os padrões.

Se o usuário não fornecer uma máscara, todos os campos que a solicitação definir como um valor não padrão serão substituídos. As mensagens enviadas vazias (por exemplo, layoutParsingConfig: {}) e os campos definidos com o valor padrão (por exemplo, false) não são aplicados. Em vez disso, nomeie-os na máscara.

Os seguintes campos podem ser atualizados: displayName, description, labels, processingConfig e documentMetadataSchema. documentMetadataSchema precisa ser atualizado como um todo (o caminho da máscara é documentMetadataSchema) e apenas adicionando propriedades: as propriedades atuais não podem ser removidas nem alteradas.

Se * for fornecido em updateMask, a substituição completa será realizada.

Uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
requestId

string

Opcional. Um ID de solicitação opcional para identificar solicitações. Especifique um ID de solicitação exclusivo para que, se precisar repetir a solicitação, o servidor saberá que é preciso ignorar a solicitação se ela já tiver sido concluída. O servidor vai garantir isso por pelo menos 60 minutos após a primeira solicitação.

Por exemplo, considere uma situação em que você faz uma solicitação inicial e ela expira. Se você fizer a solicitação novamente com o mesmo ID, o servidor poderá verificar se a operação original com o mesmo ID foi recebida e, em caso afirmativo, vai ignorar a segunda solicitação. Isso evita que os clientes criem compromissos duplicados acidentalmente.

O ID da solicitação precisa ser um UUID válido. O valor zero não é aceito (00000000-0000-0000-0000-000000000000).

Corpo da solicitação

O corpo da solicitação contém uma instância de DataStore.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.