Method: settings.datasources.update

Atualiza uma fonte de dados.

Observação:essa API exige uma conta de administrador para ser executada.

Solicitação HTTP

PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
source.name

string

O nome do recurso da fonte de dados. Formato: fontes de dados/{sourceId}.

Esse nome é ignorado na criação da fonte de dados.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "source": {
    "name": string,
    "displayName": string,
    "shortName": string,
    "indexingServiceAccounts": [
      string
    ],
    "disableServing": boolean,
    "disableModifications": boolean,
    "itemsVisibility": [
      {

        // Union field gsuite_principal can be only one of the following:
        "gsuiteUserEmail": string,
        "gsuiteGroupEmail": string,
        "gsuiteDomain": boolean
        // End of list of possible types for union field gsuite_principal.
      }
    ],
    "returnThumbnailUrls": boolean,
    "operationIds": [
      string
    ]
  },
  "debugOptions": {
    object (DebugOptions)
  },
  "updateMask": string
}
Campos
source.displayName

string

Obrigatório. Nome de exibição da fonte de dados. O tamanho máximo é de 300 caracteres.
source.shortName

string

Um nome curto ou alias para a fonte. Esse valor será usado para corresponder à "origem" usando um operador lógico. Por exemplo, se o nome curto for <value>, consultas como <value> só retornarão resultados para essa origem. O valor precisa ser exclusivo em todas as fontes de dados. O valor precisa conter apenas caracteres alfanuméricos (a-zA-Z0-9). O valor não pode começar com "google". e não pode ser um destes: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people e times. O tamanho máximo é de 32 caracteres.
source.indexingServiceAccounts[]

string

Lista de contas de serviço com acesso de indexação.
source.disableServing

boolean

Desativa a veiculação de resultados de pesquisa ou assistência.
source.disableModifications

boolean

Se verdadeiro, define a fonte de dados para o modo somente leitura. No modo somente leitura, a API Indexing rejeita todas as solicitações para indexar ou excluir itens nessa origem. Ativar o modo somente leitura não interrompe o processamento dos dados aceitos anteriormente.
source.itemsVisibility[]

object (GSuitePrincipal)

Esse campo restringe a visibilidade de itens no nível da fonte de dados. Os itens da fonte de dados são restritos à união de usuários e grupos incluídos nesse campo. Isso não garante o acesso a um item específico, pois os usuários precisam ter permissões de ACL nos itens contidos. Isso garante acesso de alto nível a toda a fonte de dados e que os itens individuais não sejam compartilhados fora dessa visibilidade.
source.returnThumbnailUrls

boolean

Um usuário pode solicitar a URI de miniatura para itens indexados nessa fonte de dados.
source.operationIds[]

string

IDs das operações de longa duração (LROs, na sigla em inglês) atualmente em execução para este esquema.
debugOptions

object (DebugOptions)

Opções comuns de depuração.
updateMask

string (FieldMask format)

Aplicável apenas ao settings.datasources.patch.

Máscara de atualização para controlar quais campos atualizar. Exemplos de caminhos de campo: name e displayName.

  • Se updateMask não estiver vazio, somente os campos especificados no updateMask serão atualizados.
  • Se você especificar um campo no updateMask, mas não especificar o valor na origem, esse campo será apagado.
  • Se o updateMask não estiver presente, vazio ou tiver o valor *, todos os campos serão atualizados.

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_search.settings.indexing
  • https://www.googleapis.com/auth/cloud_search.settings
  • https://www.googleapis.com/auth/cloud_search

Para mais informações, consulte o Guia de autorização.