REST Resource: settings.datasources
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: DataSource
A origem de dados é um namespace lógico para itens a serem indexados. Todos os itens precisam pertencer a uma fonte de dados. Esse é o pré-requisito para que os itens possam ser indexados no Cloud Search.
Representação JSON |
{
"name": string,
"displayName": string,
"shortName": string,
"indexingServiceAccounts": [
string
],
"disableServing": boolean,
"disableModifications": boolean,
"itemsVisibility": [
{
object (GSuitePrincipal )
}
],
"returnThumbnailUrls": boolean,
"operationIds": [
string
]
} |
Campos |
name |
string
O nome do recurso da fonte de dados. Formato: datasources/{sourceId}. O nome é ignorado ao criar uma fonte de dados.
|
displayName |
string
Obrigatório. Nome de exibição da origem de dados. O comprimento máximo é de 300 caracteres.
|
shortName |
string
Um nome curto ou alias para a origem. Esse valor será usado para corresponder ao operador "source". Por exemplo, se o nome abreviado for <value>, consultas como source:<value> só vão retornar 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" nem ser um dos seguintes: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. O tamanho máximo é de 32 caracteres.
|
indexingServiceAccounts[] |
string
Lista de contas de serviço com acesso de indexação.
|
disableServing |
boolean
Desative a veiculação de qualquer resultado de pesquisa ou assistência.
|
disableModifications |
boolean
Se verdadeiro, define a fonte de dados como 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 de dados aceitos anteriormente.
|
itemsVisibility[] |
object (GSuitePrincipal )
Esse campo restringe a visibilidade dos itens no nível da fonte de dados. Os itens na 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, porque os usuários precisam ter permissões de ACL nos itens contidos. Isso garante um acesso de alto nível a toda a fonte de dados e que os itens individuais não sejam compartilhados fora dessa visibilidade.
|
returnThumbnailUrls |
boolean
Um usuário pode solicitar o URI da miniatura de itens indexados nessa fonte de dados.
|
operationIds[] |
string
IDs das operações de longa duração (LROs, na sigla em inglês) em execução para este esquema.
|
Métodos |
|
Cria uma fonte de dados. |
|
Exclui uma origem de dados. |
|
Recebe uma fonte de dados. |
|
Lista as fontes de dados. |
|
Atualiza uma fonte de dados. |
|
Atualiza uma fonte de dados. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# REST Resource: settings.datasources\n\n- [Resource: DataSource](#DataSource)\n - [JSON representation](#DataSource.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: DataSource\n--------------------\n\nDatasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"shortName\": string, \"indexingServiceAccounts\": [ string ], \"disableServing\": boolean, \"disableModifications\": boolean, \"itemsVisibility\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/GSuitePrincipal) } ], \"returnThumbnailUrls\": boolean, \"operationIds\": [ string ] } ``` |\n\n| Fields ||\n|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the datasource resource. Format: datasources/{sourceId}. The name is ignored when creating a datasource. |\n| `displayName` | `string` Required. Display name of the datasource The maximum length is 300 characters. |\n| `shortName` | `string` A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *\\\u003cvalue\\\u003e* then queries like *source:\\\u003cvalue\\\u003e* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. |\n| `indexingServiceAccounts[]` | `string` List of service accounts that have indexing access. |\n| `disableServing` | `boolean` Disable serving any search or assist results. |\n| `disableModifications` | `boolean` If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data. |\n| `itemsVisibility[]` | `object (`[GSuitePrincipal](/workspace/cloud-search/docs/reference/rest/v1/GSuitePrincipal)`)` This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. |\n| `returnThumbnailUrls` | `boolean` Can a user request to get thumbnail URI for Items indexed in this data source. |\n| `operationIds[]` | `string` IDs of the Long Running Operations (LROs) currently running for this schema. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------|-----------------------|\n| ### [create](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/create) | Creates a datasource. |\n| ### [delete](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/delete) | Deletes a datasource. |\n| ### [get](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/get) | Gets a datasource. |\n| ### [list](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/list) | Lists datasources. |\n| ### [patch](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch) | Updates a datasource. |\n| ### [update](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/update) | Updates a datasource. |"]]