SearchService Interface

  • Reference
Package:
com.microsoft.azure.management.search

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

An immutable client-side representation of an Azure registry.

Method Summary

Modifier and Type Method and Description
QueryKey createQueryKey(String name)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.
Observable<QueryKey> createQueryKeyAsync(String name)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.
void deleteQueryKey(String key)

Deletes the specified query key.

Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
Completable deleteQueryKeyAsync(String key)

Deletes the specified query key.

Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
AdminKeys getAdminKeys()

The primary and secondary admin API keys for the specified Azure Search service.
Observable<AdminKeys> getAdminKeysAsync()

The primary and secondary admin API keys for the specified Azure Search service.
HostingMode hostingMode()

The hosting mode value.

Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
List<QueryKey> listQueryKeys()

Returns the list of query API keys for the given Azure Search service.
Observable<QueryKey> listQueryKeysAsync()

Returns the list of query API keys for the given Azure Search service.
int partitionCount()
ProvisioningState provisioningState()

The state of the last provisioning operation performed on the Search service.

Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create Search service. This is because the free service uses capacity that is already set up.
AdminKeys regenerateAdminKeys(AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.
Observable<AdminKeys> regenerateAdminKeysAsync(AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
int replicaCount()
Sku sku()
SearchServiceStatus status()

The status of the Search service.

Possible values include: 'running': the Search service is running and no provisioning operations are underway. 'provisioning': the Search service is being provisioned or scaled up or down. 'deleting': the Search service is being deleted. 'degraded': the Search service is degraded. This can occur when the underlying search units are not healthy. The Search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': the Search service is disabled. In this state, the service will reject all API requests. 'error': the Search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
String statusDetails()

Inherited Members

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

Method Details

createQueryKey

public QueryKey createQueryKey(String name)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.

Parameters:

name - The name of the new query API key.

Returns:

the <QueryKey> object if successful

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createQueryKeyAsync

public Observable createQueryKeyAsync(String name)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.

Parameters:

name - The name of the new query API key.

Returns:

a representation of the future computation of this call

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteQueryKey

public void deleteQueryKey(String key)

Deletes the specified query key.

Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.

Parameters:

key - The query key to be deleted. Query keys are identified by value, not by name.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteQueryKeyAsync

public Completable deleteQueryKeyAsync(String key)

Deletes the specified query key.

Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.

Parameters:

key - The query key to be deleted. Query keys are identified by value, not by name.

Returns:

a representation of the future computation of this call

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAdminKeys

public AdminKeys getAdminKeys()

The primary and secondary admin API keys for the specified Azure Search service.

Returns:

the AdminKeys object if successful

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAdminKeysAsync

public Observable getAdminKeysAsync()

The primary and secondary admin API keys for the specified Azure Search service.

Returns:

a representation of the future computation of this call

Throws:

IllegalArgumentException - thrown if parameters fail the validation

hostingMode

public HostingMode hostingMode()

The hosting mode value.

Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.

Returns:

the hosting mode value.

listQueryKeys

public List listQueryKeys()

Returns the list of query API keys for the given Azure Search service.

Returns:

the List<QueryKey> object if successful

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listQueryKeysAsync

public Observable listQueryKeysAsync()

Returns the list of query API keys for the given Azure Search service.

Returns:

the observable to the List<QueryKey> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

partitionCount

public int partitionCount()

Returns:

the number of partitions used by the service

provisioningState

public ProvisioningState provisioningState()

The state of the last provisioning operation performed on the Search service.

Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create Search service. This is because the free service uses capacity that is already set up.

Returns:

the provisioning state of the resource

regenerateAdminKeys

public AdminKeys regenerateAdminKeys(AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.

Parameters:

keyKind - specifies which key to regenerate

Returns:

the AdminKeys object if successful

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

regenerateAdminKeysAsync

public Observable regenerateAdminKeysAsync(AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

Parameters:

keyKind - Specifies which key to regenerate

Returns:

a representation of the future computation of this call

Throws:

IllegalArgumentException - thrown if parameters fail the validation

replicaCount

public int replicaCount()

Returns:

the number of replicas used by the service

sku

public Sku sku()

Returns:

the SKU type of the service

status

public SearchServiceStatus status()

The status of the Search service.

Possible values include: 'running': the Search service is running and no provisioning operations are underway. 'provisioning': the Search service is being provisioned or scaled up or down. 'deleting': the Search service is being deleted. 'degraded': the Search service is degraded. This can occur when the underlying search units are not healthy. The Search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': the Search service is disabled. In this state, the service will reject all API requests. 'error': the Search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.

Returns:

the status of the service

statusDetails

public String statusDetails()

Returns:

the details of the status.

Applies to