SearchService Interface

Pacote:

com.microsoft.azure.management.search

public interface SearchService extends GroupableResource<SearchServiceManager, SearchServiceInner>,Refreshable,Updatable<SearchService.Update>

Uma representação imutável do lado do cliente de um registro do Azure.

Resumo do método

Modificador e tipo	Método e descrição
QueryKey	createQueryKey(String name) Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.
Observable<QueryKey>	createQueryKeyAsync(String name) Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.
void	deleteQueryKey(String key) Exclui a chave de consulta especificada. Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta consiste em excluí-la e recriá-la.
Completable	deleteQueryKeyAsync(String key) Exclui a chave de consulta especificada. Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta consiste em excluí-la e recriá-la.
AdminKeys	getAdminKeys() As chaves da API de administração primária e secundária para o serviço Pesquisa do Azure especificado.
Observable<AdminKeys>	getAdminKeysAsync() As chaves da API de administração primária e secundária para o serviço Pesquisa do Azure especificado.
HostingMode	hostingMode() O valor do modo de hospedagem. Aplicável somente para o SKU standard3. Você pode definir essa propriedade para habilitar até três partições de alta densidade que permitem até 1000 índices, o que é muito maior do que os índices máximos permitidos para qualquer outra SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser "padrão".
List<QueryKey>	listQueryKeys() Retorna a lista de chaves de API de consulta para o serviço Azure Search especificado.
Observable<QueryKey>	listQueryKeysAsync() Retorna a lista de chaves de API de consulta para o serviço Azure Search especificado.
int	partitionCount()
ProvisioningState	provisioningState() O estado da última operação de provisionamento executada no serviço Pesquisa. O provisionamento é um estado intermediário que ocorre enquanto a capacidade de serviço está sendo estabelecida. Depois que a capacidade é configurada, provisioningState é alterado para 'bem-sucedido' ou 'falhou'. Os aplicativos cliente podem sondar o provisionamento status (o intervalo de sondagem recomendado é de 30 segundos a um minuto) usando a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se você estiver usando o serviço gratuito, esse valor tende a voltar como "bem-sucedido" diretamente na chamada para Criar serviço Pesquisa. Isso ocorre porque o serviço gratuito usa a capacidade que já está configurada.
AdminKeys	regenerateAdminKeys(AdminKeyKind keyKind) Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.
Observable<AdminKeys>	regenerateAdminKeysAsync(AdminKeyKind keyKind) Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.
int	replicaCount()
Sku	sku()
SearchServiceStatus	status() O status do serviço Pesquisa. Os valores possíveis incluem: "em execução": o serviço Pesquisa está em execução e nenhuma operação de provisionamento está em andamento. 'provisionamento': o serviço Pesquisa está sendo provisionado ou escalado verticalmente ou reduzido verticalmente. 'deleting': o serviço Pesquisa está sendo excluído. 'degradado': a serviço Pesquisa está degradada. Isso pode ocorrer quando as unidades de pesquisa subjacentes não estão íntegras. O serviço de pesquisa provavelmente está funcionando, mas o desempenho pode ser lento e algumas solicitações podem ser descartadas. 'desabilitado': a serviço Pesquisa está desabilitada. Nesse estado, o serviço rejeita todas as solicitações da API. 'error': o serviço Pesquisa está em um estado de erro. Se o serviço estiver nos estados degradados, desabilitados ou de erro, isso significa que a equipe do Azure Search está investigando ativamente o problema subjacente. Serviços dedicados nesses estados ainda são passíveis de cobrança com base no número de unidades de pesquisa provisionadas.
String	statusDetails()

Membros herdados

HasId.id() HasInner<T>.inner() Indexable.key() HasManager<ManagerT>.manager() HasName.name() Refreshable<T>.refresh() Refreshable<T>.refreshAsync() Resource.region() Resource.regionName() HasResourceGroup.resourceGroupName() Resource.tags() Resource.type() Updatable<T>.update()

Detalhes do método

createQueryKey

public QueryKey createQueryKey(String name)

Regenera a chave de API de administrador primário ou secundário.

Você só pode regenerar uma chave de cada vez.

Parâmetros:

name - O nome da nova chave de API de consulta.

Retornos:

o <objeto QueryKey> se tiver êxito

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

CloudException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

createQueryKeyAsync

public Observable createQueryKeyAsync(String name)

Regenera a chave de API de administrador primário ou secundário.

Você só pode regenerar uma chave de cada vez.

Parâmetros:

name - O nome da nova chave de API de consulta.

Retornos:

uma representação da computação futura dessa chamada

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

deleteQueryKey

public void deleteQueryKey(String key)

Exclui a chave de consulta especificada.

Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta consiste em excluí-la e recriá-la.

Parâmetros:

key - A chave de consulta a ser excluída. As chaves de consulta são identificadas por valor, não por nome.

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

CloudException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

deleteQueryKeyAsync

public Completable deleteQueryKeyAsync(String key)

Exclui a chave de consulta especificada.

Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta consiste em excluí-la e recriá-la.

Parâmetros:

key - A chave de consulta a ser excluída. As chaves de consulta são identificadas por valor, não por nome.

Retornos:

uma representação da computação futura dessa chamada

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

getAdminKeys

public AdminKeys getAdminKeys()

As chaves da API de administração primária e secundária para o serviço Pesquisa do Azure especificado.

Retornos:

o objeto AdminKeys se tiver êxito

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

CloudException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

getAdminKeysAsync

public Observable getAdminKeysAsync()

As chaves da API de administração primária e secundária para o serviço Pesquisa do Azure especificado.

Retornos:

uma representação da computação futura dessa chamada

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

hostingMode

public HostingMode hostingMode()

O valor do modo de hospedagem.

Aplicável somente para o SKU standard3. Você pode definir essa propriedade para habilitar até três partições de alta densidade que permitem até 1000 índices, o que é muito maior do que os índices máximos permitidos para qualquer outra SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser "padrão".

Retornos:

o valor do modo de hospedagem.

listQueryKeys

public List listQueryKeys()

Retorna a lista de chaves de API de consulta para o serviço Azure Search especificado.

Retornos:

o objeto List<QueryKey> se tiver êxito

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

CloudException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

listQueryKeysAsync

public Observable listQueryKeysAsync()

Retorna a lista de chaves de API de consulta para o serviço Azure Search especificado.

Retornos:

o observável para o objeto List<QueryKey>

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

partitionCount

public int partitionCount()

Retornos:

o número de partições usadas pelo serviço

provisioningState

public ProvisioningState provisioningState()

O estado da última operação de provisionamento executada no serviço Pesquisa.

O provisionamento é um estado intermediário que ocorre enquanto a capacidade de serviço está sendo estabelecida. Depois que a capacidade é configurada, provisioningState é alterado para 'bem-sucedido' ou 'falhou'. Os aplicativos cliente podem sondar o provisionamento status (o intervalo de sondagem recomendado é de 30 segundos a um minuto) usando a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se você estiver usando o serviço gratuito, esse valor tende a voltar como "bem-sucedido" diretamente na chamada para Criar serviço Pesquisa. Isso ocorre porque o serviço gratuito usa a capacidade que já está configurada.

Retornos:

o estado de provisionamento do recurso

regenerateAdminKeys

public AdminKeys regenerateAdminKeys(AdminKeyKind keyKind)

Regenera a chave de API de administrador primário ou secundário.

Você só pode regenerar uma chave de cada vez.

Parâmetros:

keyKind - especifica qual chave regenerar

Retornos:

o objeto AdminKeys se tiver êxito

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

CloudException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

regenerateAdminKeysAsync

public Observable regenerateAdminKeysAsync(AdminKeyKind keyKind)

Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.

Parâmetros:

keyKind - Especifica qual chave deve ser gerada novamente

Retornos:

uma representação da computação futura dessa chamada

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

replicaCount

public int replicaCount()

Retornos:

o número de réplicas usadas pelo serviço

sku

public Sku sku()

Retornos:

o tipo de SKU do serviço

status

public SearchServiceStatus status()

O status do serviço Pesquisa.

Os valores possíveis incluem: "em execução": o serviço Pesquisa está em execução e nenhuma operação de provisionamento está em andamento. 'provisionamento': o serviço Pesquisa está sendo provisionado ou escalado verticalmente ou reduzido verticalmente. 'deleting': o serviço Pesquisa está sendo excluído. 'degradado': a serviço Pesquisa está degradada. Isso pode ocorrer quando as unidades de pesquisa subjacentes não estão íntegras. O serviço de pesquisa provavelmente está funcionando, mas o desempenho pode ser lento e algumas solicitações podem ser descartadas. 'desabilitado': a serviço Pesquisa está desabilitada. Nesse estado, o serviço rejeita todas as solicitações da API. 'error': o serviço Pesquisa está em um estado de erro. Se o serviço estiver nos estados degradados, desabilitados ou de erro, isso significa que a equipe do Azure Search está investigando ativamente o problema subjacente. Serviços dedicados nesses estados ainda são passíveis de cobrança com base no número de unidades de pesquisa provisionadas.

Retornos:

o status do serviço

statusDetails

public String statusDetails()

Retornos:

os detalhes do status.