- Recurso: item
- ItemAcl
- ItemAcl.AclInheritanceType
- Principal
- ItemMetadata
- Interação
- Interaction.InteractionType
- SearchQualityMetadata
- ContextAttribute
- ItemStructuredData
- StructuredDataObject
- NamedProperty
- NamedProperty.IntegerValues
- NamedProperty.DoubleValues
- NamedProperty.TimestampValues
- NamedProperty.ObjectValues
- NamedProperty.EnumValues
- NamedProperty.DateValues
- NamedProperty.TextValues
- NamedProperty.HtmlValues
- ItemContent
- ItemContent.ContentFormat
- UploadItemRef
- ItemStatus
- ProcessingError
- ProcessingErrorCode
- FieldViolation
- RepositoryError
- RepositoryError.Type
- Item.ItemType
- Métodos
Recurso: item
Representa um único objeto que é um item no índice de pesquisa, como um arquivo, pasta ou um registro de banco de dados.
Representação JSON |
---|
{ "name": string, "acl": { object ( |
Campos | |
---|---|
name |
Nome do item. Formato: datasources/{sourceId}/items/{itemId} Este campo é obrigatório. O tamanho máximo é de 1.536 caracteres. |
acl |
Lista de controle de acesso para este item. |
metadata |
As informações dos metadados. |
structuredData |
São os dados estruturados do item que precisam estar em conformidade com a definição de objeto registrado no esquema da fonte de dados. |
content |
Conteúdo do item a ser indexado e texto pesquisável. |
version |
Obrigatório. O sistema de indexação armazena a versão da fonte de dados como uma string de bytes e compara a versão do item no índice com a versão do item na fila usando a ordenação lexical. A indexação do Cloud Search não vai indexar nem excluir itens na fila com um valor de versão menor ou igual à versão do item indexado no momento. O tamanho máximo desse campo é de 1.024 bytes. Para saber mais sobre como a versão do item afeta o processo de exclusão, consulte Processar revisões após exclusões manuais. Uma string codificada em base64. |
status |
Status do item. Campo somente de saída. |
queue |
Fila a que este item pertence. O comprimento máximo é de 100 caracteres. |
payload |
O conector de estado adicional pode armazenar para esse item. O tamanho máximo é de 10.000 bytes. Uma string codificada em base64. |
itemType |
Tipo do item. |
ItemAcl
Informações da lista de controle de acesso para o item. Para mais informações, consulte Mapear ACLs.
Representação JSON |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
Campos | |
---|---|
inheritAclFrom |
O nome do item de onde a lista de permissões de acesso (ACL, na sigla em inglês) será herdada. Observação: a herança da ACL concede apenas permissões de acesso a itens filhos e não define relações estruturais, nem fornece maneiras convenientes de excluir grandes grupos de itens. A exclusão de um pai da ACL do índice muda apenas as permissões de acesso dos itens filhos que fazem referência ao pai no campo |
aclInheritanceType |
Define o tipo de regras de acesso a serem aplicadas quando um item herda a ACL de um pai. Isso sempre precisa ser definido em conjunto com o campo |
readers[] |
Lista de principais que têm permissão para ver o item nos resultados da pesquisa. Opcional se herdar permissões de outro item ou se o item não deveria estar visível, como |
deniedReaders[] |
Lista de principais que tiveram o acesso explicitamente negado ao item nos resultados da pesquisa. Embora o acesso aos principais tenha sido negado por padrão, use os leitores negados para processar exceções e substituir os leitores permitidos da lista. O número máximo de elementos é 100. |
owners[] |
Opcional. Lista de proprietários do item. Esse campo não afeta as permissões de acesso ao documento. No entanto, ela oferece uma pequena classificação impulsiona os itens em que o usuário que consulta é um proprietário. O número máximo de elementos é 5. |
ItemAcl.AclInheritanceType
Os tipos de herança da ACL.
Enums | |
---|---|
NOT_APPLICABLE |
O valor padrão quando este item não herda uma ACL. Use NOT_APPLICABLE quando inheritAclFrom estiver vazio. Um item sem herança de ACL ainda pode ter ACLs fornecidas pelos próprios campos readers e deniedReaders . |
CHILD_OVERRIDE |
Durante um conflito de autorização, a ACL do item filho determina o acesso de leitura. |
PARENT_OVERRIDE |
Durante um conflito de autorização, a ACL do item pai especificado no campo inheritAclFrom determina o acesso de leitura. |
BOTH_PERMIT |
O acesso só será concedido se esse item e o item pai especificado no campo inheritAclFrom permitirem acesso de leitura. |
Principal
Referência a um usuário, grupo ou domínio.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
gsuitePrincipal |
Este principal é um usuário, grupo ou domínio do Google Workspace. |
userResourceName |
Este principal é um usuário identificado com uma identidade externa. O campo "name" precisa especificar o nome do recurso do usuário com este formato: Identitysources/{sourceId}/users/{ID} |
groupResourceName |
Este principal é um grupo identificado usando uma identidade externa. O campo name precisa especificar o nome do recurso do grupo com este formato: Identitysources/{sourceId}/groups/{ID} |
ItemMetadata
Campos de metadados disponíveis para o item.
Representação JSON |
---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
Campos | |
---|---|
title |
Título do item. Se fornecido, será o título exibido do resultado de query.search. O tamanho máximo é de 2.048 caracteres. |
sourceRepositoryUrl |
Link para o repositório de origem que exibe os dados. Os resultados da pesquisa aplicam este link ao título. Espaços em branco ou caracteres especiais podem fazer com que os links de resultado do Cloud Search acionem um aviso de redirecionamento. Para evitar isso, codifique o URL. O tamanho máximo é de 2.048 caracteres. |
containerName |
O nome do contêiner deste item. A exclusão do item do contêiner resulta na exclusão automática dele. Observação: as ACLs não são herdadas de um item do contêiner. Para conceder a herança de ACL para um item, use o campo |
objectType |
Tipo do item. Precisa corresponder ao nome de uma definição de objeto no esquema registrado para a fonte de dados. Por exemplo, se o esquema da fonte de dados contém uma definição de objeto com o nome "document", as solicitações de indexação de itens para objetos desse tipo precisam definir "objectType" como "document". O tamanho máximo é de 256 caracteres. |
createTime |
A hora em que o item foi criado no repositório de origem. Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
updateTime |
A hora em que o item foi modificado pela última vez no repositório de origem. Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
interactions[] |
Uma lista de interações para o item. As interações são usadas para melhorar a qualidade da query.search, mas não são expostas aos usuários finais. O número máximo de elementos é 1.000. |
contentLanguage |
O código de idioma BCP-47 para o item, como "pt-BR" ou "en-US". Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. O tamanho máximo é de 32 caracteres. |
mimeType |
O tipo MIME original de |
searchQualityMetadata |
Metadados adicionais de qualidade da pesquisa do item |
keywords[] |
Outras palavras-chave ou frases que devem corresponder ao item. Usado internamente para conteúdo gerado pelo usuário. O número máximo de elementos é 100. O tamanho máximo é de 8.192 caracteres. |
hash |
Valor de hash fornecido pelo autor da chamada da API. Isso pode ser usado com o método |
contextAttributes[] |
Um conjunto de atributos nomeados associados ao item. Isso pode ser usado para influenciar a classificação do item com base no contexto na solicitação. O número máximo de elementos é 10. |
Interação
Representa uma interação entre um usuário e um item.
Representação JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
|
principal |
O usuário que agiu no item. |
interactionTime |
A hora em que o usuário agiu em relação ao item. Se houver várias ações do mesmo tipo para um único usuário, somente a mais recente será registrada. Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
Interaction.InteractionType
O tipo de atividade que o usuário realizou no item.
Enums | |
---|---|
UNSPECIFIED |
Valor inválido. |
VIEW |
Essa interação indica que o usuário visualizou o item. |
EDIT |
Essa interação indica que o usuário editou o item. |
SearchQualityMetadata
Metadados adicionais de qualidade da pesquisa do item.
Representação JSON |
---|
{ "quality": number } |
Campos | |
---|---|
quality |
Uma indicação da qualidade do item, usada para influenciar a qualidade da pesquisa. O valor deve estar entre 0,0 (qualidade mais baixa) e 1,0 (qualidade mais alta). O valor padrão é 0,0. |
ContextAttribute
Um atributo nomeado associado a um item que pode ser usado para influenciar a classificação dele com base no contexto da solicitação.
Representação JSON |
---|
{ "name": string, "values": [ string ] } |
Campos | |
---|---|
name |
O nome do atributo. Ele não deve ficar em branco. O tamanho máximo é de 32 caracteres. O nome precisa começar com uma letra e só pode conter letras (A-Z, a-z) ou números (0-9). O nome será normalizado (em letras minúsculas) antes de ser correspondido. |
values[] |
Valores de texto do atributo. O número máximo de elementos é 10. O comprimento máximo de um elemento na matriz é de 32 caracteres. O valor será normalizado (em letras minúsculas) antes de ser correspondido. |
ItemStructuredData
Campos de dados estruturados disponíveis para o item.
Representação JSON |
---|
{
"object": {
object ( |
Campos | |
---|---|
object |
O objeto de dados estruturados que precisa estar em conformidade com uma definição de objeto registrado no esquema da fonte de dados. |
hash |
Valor de hash fornecido pelo autor da chamada da API. Isso pode ser usado com o método |
StructuredDataObject
Um objeto de dados estruturados que consiste em propriedades nomeadas.
Representação JSON |
---|
{
"properties": [
{
object ( |
Campos | |
---|---|
properties[] |
As propriedades do objeto. O número máximo de elementos é 1.000. |
NamedProperty
Um par de nome-valor digitado para dados estruturados. O tipo do valor precisa ser igual ao tipo registrado da propriedade name
na definição do objeto objectType
.
Representação JSON |
---|
{ "name": string, // Union field |
Campos | |
---|---|
name |
O nome da propriedade. Esse nome precisa corresponder ao da propriedade que foi registrada para a definição do objeto no esquema. O tamanho máximo permitido para essa propriedade é de 256 caracteres. |
Campo de união value . Os valores da propriedade nomeada. Uma propriedade pode conter apenas valores de um tipo. value pode ser apenas de um dos tipos a seguir: |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
NamedProperty.IntegerValues
Lista de valores inteiros.
Representação JSON |
---|
{ "values": [ string ] } |
Campos | |
---|---|
values[] |
|
NamedProperty.DoubleValues
Lista de valores duplos.
Representação JSON |
---|
{ "values": [ number ] } |
Campos | |
---|---|
values[] |
|
NamedProperty.TimestampValues
Lista de valores de carimbo de data/hora.
Representação JSON |
---|
{ "values": [ string ] } |
Campos | |
---|---|
values[] |
Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
NamedProperty.ObjectValues
Lista de valores de objetos.
Representação JSON |
---|
{
"values": [
{
object ( |
Campos | |
---|---|
values[] |
|
NamedProperty.EnumValues
Lista de valores de tipo enumerado.
Representação JSON |
---|
{ "values": [ string ] } |
Campos | |
---|---|
values[] |
O tamanho máximo permitido para valores de string é de 32 caracteres. |
NamedProperty.DateValues
Lista de valores de data.
Representação JSON |
---|
{
"values": [
{
object ( |
Campos | |
---|---|
values[] |
|
NamedProperty.TextValues
Lista de valores de texto.
Representação JSON |
---|
{ "values": [ string ] } |
Campos | |
---|---|
values[] |
O tamanho máximo permitido para valores de texto é de 2.048 caracteres. |
NamedProperty.HtmlValues
Lista de valores HTML.
Representação JSON |
---|
{ "values": [ string ] } |
Campos | |
---|---|
values[] |
O tamanho máximo permitido para valores html é de 2.048 caracteres. |
ItemContent
Conteúdo de um item a ser indexado e exibido pelo Cloud Search. Apenas strings codificadas em UTF-8 são permitidas como inlineContent
. Se o conteúdo for enviado, e não for binário, ele precisará ser codificado em UTF-8.
Representação JSON |
---|
{ "contentFormat": enum ( |
Campos | |
---|---|
contentFormat |
|
hash |
Informações de hash calculadas e fornecidas pelo cliente da API para conteúdo. Pode ser usado com o método items.push para calcular o estado modificado. O tamanho máximo é de 2.048 caracteres. |
Campo de união
|
|
inlineContent |
Conteúdo fornecido inline no método de atualização. O tamanho máximo é de 102.400 bytes (100 KiB). Uma string codificada em base64. |
contentDataRef |
Faça upload do ID de referência de um conteúdo enviado anteriormente com o método de gravação. |
ItemContent.ContentFormat
Formato do conteúdo. Se o formato for RAW, o conteúdo precisará estar no formato especificado por mimeType
.
Enums | |
---|---|
UNSPECIFIED |
Valor inválido. |
HTML |
contentFormat é HTML. |
TEXT |
contentFormat é um texto livre. |
RAW |
contentFormat são bytes brutos. |
UploadItemRef
Representa uma referência de sessão de upload. Essa referência é criada com upload method
. Essa referência é válida por 30 dias após a criação. A atualização do conteúdo do item pode se referir a este conteúdo enviado por meio de contentDataRef
.
Representação JSON |
---|
{ "name": string } |
Campos | |
---|---|
name |
O nome da referência de conteúdo. O tamanho máximo é de 2.048 caracteres. |
ItemStatus
Contém o status do item e todos os erros.
Representação JSON |
---|
{ "code": enum ( |
Campos | |
---|---|
code |
Código de status. |
processingErrors[] |
Detalhes do erro caso o item esteja no estado ERRO. |
repositoryErrors[] |
Erro de repositório informado pelo conector. |
ProcessingError
Representação JSON |
---|
{ "code": enum ( |
Campos | |
---|---|
code |
Código de erro indicando a natureza do erro. |
errorMessage |
Descrição do erro. |
fieldViolations[] |
Se os campos do item forem inválidos, ele vai conter os detalhes sobre os erros de validação. |
ProcessingErrorCode
Códigos para indicar o erro encontrado durante o processamento de itens pelo servidor do Cloud Search. Um único item pode conter vários erros de processamento.
Enums | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
Valor somente de entrada. Use esse valor em Itens. |
MALFORMED_REQUEST |
A ACL, os metadados ou o conteúdo do item estão incorretos ou em estado inválido. FieldViolações contém mais detalhes sobre onde está o problema. |
UNSUPPORTED_CONTENT_FORMAT |
O formato de contagem não é compatível. |
INDIRECT_BROKEN_ACL |
Itens com informações incompletas da ACL devido à herança de outros itens com ACL corrompida ou por ter grupos com descendentes não mapeados. |
ACL_CYCLE |
O gráfico de herança da ACL formou um ciclo. |
FieldViolation
Representação JSON |
---|
{ "field": string, "description": string } |
Campos | |
---|---|
field |
Caminho do campo com violação. |
description |
Descrição do erro. |
RepositoryError
Erros na comunicação do conector com o repositório de origem.
Representação JSON |
---|
{
"type": enum ( |
Campos | |
---|---|
type |
O tipo de erro. |
httpStatusCode |
Códigos de erro. Corresponde à definição dos códigos de status HTTP. |
errorMessage |
Mensagem que descreve o erro. O tamanho máximo permitido da mensagem é de 8.192 caracteres. |
RepositoryError.Type
Lista de códigos de erro para problemas de comunicação com o repositório.
Enums | |
---|---|
UNKNOWN |
Erro desconhecido. |
NETWORK_ERROR |
Host desconhecido ou inacessível. |
DNS_ERROR |
Problema de DNS, por exemplo, o servidor DNS não está respondendo. |
CONNECTION_ERROR |
Não é possível se conectar ao servidor do repositório. |
AUTHENTICATION_ERROR |
Falha na autenticação devido a credenciais incorretas. |
AUTHORIZATION_ERROR |
A conta de serviço não está autorizada para o repositório. |
SERVER_ERROR |
Erro no servidor do repositório. |
QUOTA_EXCEEDED |
Cota excedida. |
SERVICE_UNAVAILABLE |
Servidor temporariamente indisponível. |
CLIENT_ERROR |
Erro relacionado ao cliente, como uma solicitação inválida do conector para o servidor do repositório. |
Item.ItemType
Enums | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
Item indexado com o único propósito de exibir informações. Esses itens não podem ser referenciados nos campos containerName ou inheritAclFrom . |
CONTAINER_ITEM |
Um item que é indexado e tem a finalidade de fornecer ACLs e/ou conter outros itens a outros itens. |
VIRTUAL_CONTAINER_ITEM |
Um item que não é indexado, mas tem a mesma finalidade que CONTAINER_ITEM. |
Métodos |
|
---|---|
|
Exclui Item resource para o nome do recurso especificado. |
|
Exclui todos os itens em uma fila. |
|
Recebe Item resource pelo nome do item. |
|
Atualiza a ACL, os metadados e o conteúdo do Item . |
|
Lista todos ou um subconjunto de Item resources . |
|
Pesquisa itens não reservados na fila de indexação e marca um conjunto como reservado, começando com itens que têm o carimbo de data/hora mais antigo do ItemStatus de prioridade mais alta. |
|
Envia um item para uma fila para pesquisa e atualização posteriores. |
|
Cancela a reserva de todos os itens de uma fila, tornando todos qualificados para pesquisa. |
|
Cria uma sessão de upload para enviar conteúdo do item. |