SearchService Interfaz

Paquete:

com.microsoft.azure.management.search

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

Representación inmutable del lado cliente de un registro de Azure.

Resumen del método

Modificador y tipo	Método y descripción
QueryKey	createQueryKey(String name) Vuelve a generar la clave de API de administración principal o secundaria. Solo puede volver a generar una clave en cada ocasión.
Observable<QueryKey>	createQueryKeyAsync(String name) Regenera la clave de API de administrador principal o secundaria. Solo puede volver a generar una clave en cada ocasión.
void	deleteQueryKey(String key) Elimina la clave de consulta especificada. A diferencia de las claves de administración, las claves de consulta no se vuelven a generar. El proceso para volver a generar la clave de consulta consiste en eliminarla y volver a crearla.
Completable	deleteQueryKeyAsync(String key) Elimina la clave de consulta especificada. A diferencia de las claves de administración, las claves de consulta no se vuelven a generar. El proceso para volver a generar la clave de consulta consiste en eliminarla y volver a crearla.
AdminKeys	getAdminKeys() Claves de API de administración principal y secundaria para el servicio Search de Azure especificado.
Observable<AdminKeys>	getAdminKeysAsync() Claves de API de administración principal y secundaria para el servicio Search de Azure especificado.
HostingMode	hostingMode() Valor del modo de hospedaje. Solo se aplica a la SKU estándar3. Puede establecer esta propiedad para habilitar hasta 3 particiones de alta densidad que permitan hasta 1000 índices, que es mucho mayor que los índices máximos permitidos para cualquier otra SKU. Para la SKU estándar3, el valor es "default" o "highDensity". Para todas las demás SKU, este valor debe ser 'default'.
List<QueryKey>	listQueryKeys() Devuelve la lista de claves de API de consulta para el servicio Azure Search dado.
Observable<QueryKey>	listQueryKeysAsync() Devuelve la lista de claves de API de consulta para el servicio Azure Search dado.
int	partitionCount()
ProvisioningState	provisioningState() Estado de la última operación de aprovisionamiento realizada en el servicio Search. El aprovisionamiento es un estado intermedio que se produce cuando se está estableciendo la capacidad de servicio. Una vez configurada la capacidad, provisioningState cambia a "succeeded" o "failed". Las aplicaciones cliente pueden sondear el estado de aprovisionamiento (el intervalo de sondeo recomendado es de 30 segundos a un minuto) mediante la operación Obtener servicio de búsqueda para ver cuándo se completa una operación. Si usa el servicio gratuito, este valor tiende a volver como "correcto" directamente en la llamada a Create servicio Search. Esto ocurre porque el servicio gratuito usa una capacidad que ya está configurada.
AdminKeys	regenerateAdminKeys(AdminKeyKind keyKind) Regenera la clave de API de administrador principal o secundaria. Solo puede volver a generar una clave en cada ocasión.
Observable<AdminKeys>	regenerateAdminKeysAsync(AdminKeyKind keyKind) Regenera la clave de API de administrador principal o secundaria. Solo puede volver a generar una clave en cada ocasión.
int	replicaCount()
Sku	sku()
SearchServiceStatus	status() Estado del servicio Search. Los valores posibles incluyen: "en ejecución": el servicio Search se está ejecutando y no hay ninguna operación de aprovisionamiento en curso. "aprovisionamiento": el servicio Search se está aprovisionando o escalando vertical o verticalmente. 'eliminar': se está eliminando el servicio Search. 'degradado': el servicio Search está degradado. Esto puede ocurrir cuando las unidades de búsqueda subyacentes no están en buen estado. El servicio Search está probablemente operativo, pero el rendimiento podría ser lento y podrían eliminarse algunas solicitudes. 'disabled': el servicio Search está deshabilitado. En este estado, el servicio rechazará todas las solicitudes de API. 'error': el servicio Search está en estado de error. Si el servicio está en los estados degradados, deshabilitados o de error, significa que el equipo de Azure Search está investigando activamente el problema subyacente. En estos estados, los servicios dedicados son todavía facturables en función del número de unidades de búsqueda aprovisionado.
String	statusDetails()

Miembros heredados

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()

Detalles del método

createQueryKey

public QueryKey createQueryKey(String name)

Vuelve a generar la clave de API de administración principal o secundaria.

Solo puede volver a generar una clave en cada ocasión.

Parámetros:

name - Nombre de la nueva clave de API de consulta.

Devoluciones:

El <objeto QueryKey> si se ejecuta correctamente

Produce:

IllegalArgumentException - se produce si los parámetros producen un error en la validación.

CloudException - se produce si el servidor rechaza la solicitud.

RuntimeException - todas las demás excepciones activadas ajustadas si no se puede enviar la solicitud

createQueryKeyAsync

public Observable createQueryKeyAsync(String name)

Regenera la clave de API de administrador principal o secundaria.

Solo puede volver a generar una clave en cada ocasión.

Parámetros:

name - Nombre de la nueva clave de API de consulta.

Devoluciones:

representación del cálculo futuro de esta llamada

Produce:

IllegalArgumentException - se produce si los parámetros producen un error en la validación.

deleteQueryKey

public void deleteQueryKey(String key)

Elimina la clave de consulta especificada.

A diferencia de las claves de administración, las claves de consulta no se vuelven a generar. El proceso para volver a generar la clave de consulta consiste en eliminarla y volver a crearla.

Parámetros:

key - Clave de consulta que se va a eliminar. Las claves de consulta se identifican por valor, no por nombre.

Produce:

IllegalArgumentException - se produce si los parámetros producen un error en la validación.

CloudException - se produce si el servidor rechaza la solicitud.

RuntimeException - todas las demás excepciones activadas ajustadas si la solicitud no se puede enviar

deleteQueryKeyAsync

public Completable deleteQueryKeyAsync(String key)

Elimina la clave de consulta especificada.

A diferencia de las claves de administración, las claves de consulta no se vuelven a generar. El proceso para volver a generar la clave de consulta consiste en eliminarla y volver a crearla.

Parámetros:

key - Clave de consulta que se va a eliminar. Las claves de consulta se identifican por valor, no por nombre.

Devoluciones:

representación del cálculo futuro de esta llamada

Produce:

IllegalArgumentException - se produce si los parámetros producen un error en la validación.

getAdminKeys

public AdminKeys getAdminKeys()

Claves de API de administración principal y secundaria para el servicio Search de Azure especificado.

Devoluciones:

El objeto AdminKeys si se ejecuta correctamente

Produce:

IllegalArgumentException - se produce si los parámetros producen un error en la validación.

CloudException - se produce si el servidor rechaza la solicitud.

RuntimeException - todas las demás excepciones activadas ajustadas si la solicitud no se puede enviar

getAdminKeysAsync

public Observable getAdminKeysAsync()

Claves de API de administración principal y secundaria para el servicio Search de Azure especificado.

Devoluciones:

representación del cálculo futuro de esta llamada

Produce:

IllegalArgumentException - se produce si los parámetros producen un error en la validación.

hostingMode

public HostingMode hostingMode()

Valor del modo de hospedaje.

Solo se aplica a la SKU estándar3. Puede establecer esta propiedad para habilitar hasta 3 particiones de alta densidad que permitan hasta 1000 índices, que es mucho mayor que los índices máximos permitidos para cualquier otra SKU. Para la SKU estándar3, el valor es "default" o "highDensity". Para todas las demás SKU, este valor debe ser 'default'.

Devoluciones:

el valor del modo de hospedaje.

listQueryKeys

public List listQueryKeys()

Devuelve la lista de claves de API de consulta para el servicio Azure Search dado.

Devoluciones:

El objeto List<QueryKey> si se ejecuta correctamente

Produce:

IllegalArgumentException - se produce si los parámetros producen un error en la validación.

CloudException - se produce si el servidor rechaza la solicitud.

RuntimeException - todas las demás excepciones activadas ajustadas si la solicitud no se puede enviar

listQueryKeysAsync

public Observable listQueryKeysAsync()

Devuelve la lista de claves de API de consulta para el servicio Azure Search dado.

Devoluciones:

que se puede observar en el objeto QueryKey> de lista<

Produce:

IllegalArgumentException - se produce si los parámetros producen un error en la validación.

partitionCount

public int partitionCount()

Devoluciones:

el número de particiones usadas por el servicio

provisioningState

public ProvisioningState provisioningState()

Estado de la última operación de aprovisionamiento realizada en el servicio Search.

El aprovisionamiento es un estado intermedio que se produce cuando se está estableciendo la capacidad de servicio. Una vez configurada la capacidad, provisioningState cambia a "succeeded" o "failed". Las aplicaciones cliente pueden sondear el estado de aprovisionamiento (el intervalo de sondeo recomendado es de 30 segundos a un minuto) mediante la operación Obtener servicio de búsqueda para ver cuándo se completa una operación. Si usa el servicio gratuito, este valor tiende a volver como "correcto" directamente en la llamada a Create servicio Search. Esto ocurre porque el servicio gratuito usa una capacidad que ya está configurada.

Devoluciones:

el estado de aprovisionamiento del recurso

regenerateAdminKeys

public AdminKeys regenerateAdminKeys(AdminKeyKind keyKind)

Regenera la clave de API de administrador principal o secundaria.

Solo puede volver a generar una clave en cada ocasión.

Parámetros:

keyKind - especifica la clave que se va a regenerar.

Devoluciones:

El objeto AdminKeys si se ejecuta correctamente

Produce:

IllegalArgumentException - se produce si los parámetros producen un error en la validación.

CloudException - se produce si el servidor rechaza la solicitud.

RuntimeException - todas las demás excepciones activadas ajustadas si la solicitud no se puede enviar

regenerateAdminKeysAsync

public Observable regenerateAdminKeysAsync(AdminKeyKind keyKind)

Regenera la clave de API de administrador principal o secundaria. Solo puede volver a generar una clave en cada ocasión.

Parámetros:

keyKind - Especifica la clave que desea regenerar

Devoluciones:

representación del cálculo futuro de esta llamada

Produce:

IllegalArgumentException - se produce si los parámetros producen un error en la validación.

replicaCount

public int replicaCount()

Devoluciones:

el número de réplicas usadas por el servicio

sku

public Sku sku()

Devoluciones:

el tipo de SKU del servicio

status

public SearchServiceStatus status()

Estado del servicio Search.

Los valores posibles incluyen: "en ejecución": el servicio Search se está ejecutando y no hay ninguna operación de aprovisionamiento en curso. "aprovisionamiento": el servicio Search se está aprovisionando o escalando vertical o verticalmente. 'eliminar': se está eliminando el servicio Search. 'degradado': el servicio Search está degradado. Esto puede ocurrir cuando las unidades de búsqueda subyacentes no están en buen estado. El servicio Search está probablemente operativo, pero el rendimiento podría ser lento y podrían eliminarse algunas solicitudes. 'disabled': el servicio Search está deshabilitado. En este estado, el servicio rechazará todas las solicitudes de API. 'error': el servicio Search está en estado de error. Si el servicio está en los estados degradados, deshabilitados o de error, significa que el equipo de Azure Search está investigando activamente el problema subyacente. En estos estados, los servicios dedicados son todavía facturables en función del número de unidades de búsqueda aprovisionado.

Devoluciones:

el estado del servicio

statusDetails

public String statusDetails()

Devoluciones:

los detalles del estado.