REST Resource: projects.locations.collections.dataStores.siteSearchEngine.targetSites

Recurso: TargetSite

Um site de destino para o SiteSearchEngine.

Representação JSON 
{
  "name": string,
  "providedUriPattern": string,
  "type": enum (Type),
  "exactMatch": boolean,
  "generatedUriPattern": string,
  "rootDomainUri": string,
  "siteVerificationInfo": {
    object (SiteVerificationInfo)
  },
  "indexingStatus": enum (IndexingStatus),
  "updateTime": string,
  "failureReason": {
    object (FailureReason)
  }
}
Campos
name

string

Apenas saída. O nome do recurso totalmente qualificado do site de destino. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite} O target_site_id é gerado pelo sistema.
providedUriPattern

string

Obrigatório. Somente entrada. O padrão de URI fornecido pelo usuário de que o generatedUriPattern é gerado.
type

enum (Type)

O tipo do site de destino, por exemplo, se ele deve ser incluído ou excluído.
exactMatch

boolean

Imutável. Se definido como "false", um uri_pattern será gerado para incluir todas as páginas cujo endereço contém o providedUriPattern. Se definido como "true", um uri_pattern será gerado para tentar ser uma correspondência exata do providedUriPattern ou apenas da página específica se o providedUriPattern for específico. O providedUriPattern é sempre normalizado para gerar o padrão de URI a ser usado pelo mecanismo de pesquisa.
generatedUriPattern

string

Apenas saída. Esse valor é gerado pelo sistema com base no providedUriPattern.
rootDomainUri

string

Apenas saída. Domínio raiz do providedUriPattern.
siteVerificationInfo

object (SiteVerificationInfo)

Apenas saída. Status da verificação da propriedade e validade do site.
indexingStatus

enum (IndexingStatus)

Apenas saída. Status da indexação.
updateTime

string (Timestamp format)

Apenas saída. O horário da última atualização do site de destino.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
failureReason

object (FailureReason)

Apenas saída. Motivo da falha.

Tipo

Tipos de site de destino possíveis.

Tipos enumerados
TYPE_UNSPECIFIED Esse valor não é usado. Nesse caso, o comportamento padrão do servidor é Type.INCLUDE.
INCLUDE Inclua o site de destino.
EXCLUDE Exclua o site de destino.

SiteVerificationInfo

Informações de verificação para sites de destino na pesquisa avançada no site.

Representação JSON 
{
  "siteVerificationState": enum (SiteVerificationState),
  "verifyTime": string
}
Campos
siteVerificationState

enum (SiteVerificationState)

Estado da verificação do site que indica a propriedade e a validade.
verifyTime

string (Timestamp format)

Hora da última verificação do site.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

SiteVerificationState

Estado da verificação do site.

Tipos enumerados
SITE_VERIFICATION_STATE_UNSPECIFIED O padrão é VERIFIED.
VERIFIED A propriedade do site foi verificada.
UNVERIFIED A verificação da propriedade do site está pendente ou falhou.
EXEMPTED Site isento de verificação, por exemplo, um site público aberto a todos.

IndexingStatus

Enumeração do status de indexação do site de destino.

Tipos enumerados
INDEXING_STATUS_UNSPECIFIED O padrão é SUCCEEDED.
PENDING O site de destino está na fila de atualização e será selecionado pelo pipeline de indexação.
FAILED O site de destino não é indexado.
SUCCEEDED O site de destino foi indexado.
DELETING O site de destino indexado anteriormente foi marcado para exclusão. Esse é um estado de transição que resulta em: 1. exclusão do site de destino se a remoção do índice for bem-sucedida; 2. reversão do estado para "SUCCEEDED" se a remoção do índice falhar.
CANCELLABLE A mudança de site de destino está pendente, mas pode ser cancelada.
CANCELLED A mudança de site de destino é cancelada.

FailureReason

Motivos de falha na indexação da pesquisa no site.

Representação JSON 
{

  // Union field failure can be only one of the following:
  "quotaFailure": {
    object (QuotaFailure)
  }
  // End of list of possible types for union field failure.
}
Campos
Campo de união failure. Motivo da falha. failure pode ser apenas de um dos tipos a seguir:
quotaFailure

object (QuotaFailure)

Falha devido à cota insuficiente.

QuotaFailure

Falha devido à cota insuficiente.

Representação JSON 
{
  "totalRequiredQuota": string
}
Campos
totalRequiredQuota

string (int64 format)

Esse número é uma estimativa de quanta cota total o projeto precisa para concluir a indexação.

Métodos

batchCreate

 Cria TargetSite em lote.

create

 Cria uma TargetSite.

delete

 Exclui um TargetSite.

get

 Recebe um TargetSite.

list

 Recebe uma lista de TargetSites.

patch

 Atualiza um TargetSite.