SearchService Interface

Package:

com.azure.resourcemanager.search.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-search:2.46.0

Implements

GroupableResource<SearchServiceManager,SearchServiceInner> Refreshable<SearchService> Updatable<Update>

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

An immutable client-side representation of an Azure Cognitive Search service.

Method Summary

Modifier and Type	Method and Description
abstract QueryKey	createQueryKey(String name) Regenerates either the primary or secondary admin API key.
abstract Mono<QueryKey>	createQueryKeyAsync(String name) Regenerates either the primary or secondary admin API key.
abstract void	deleteQueryKey(String key) Deletes the specified query key.
abstract Mono<Void>	deleteQueryKeyAsync(String key) Deletes the specified query key.
abstract AdminKeys	getAdminKeys() The primary and secondary admin API keys for the specified Azure Search service.
abstract Mono<AdminKeys>	getAdminKeysAsync() The primary and secondary admin API keys for the specified Azure Search service.
abstract HostingMode	hostingMode() The hosting mode value.
abstract PagedIterable<QueryKey>	listQueryKeys() Returns the list of query API keys for the given Azure Search service.
abstract PagedFlux<QueryKey>	listQueryKeysAsync() Returns the list of query API keys for the given Azure Search service.
abstract int	partitionCount()
abstract ProvisioningState	provisioningState() The state of the last provisioning operation performed on the Search service.
abstract PublicNetworkAccess	publicNetworkAccess() Whether the search service can be accessed from public network.
abstract AdminKeys	regenerateAdminKeys(AdminKeyKind keyKind) Regenerates either the primary or secondary admin API key.
abstract Mono<AdminKeys>	regenerateAdminKeysAsync(AdminKeyKind keyKind) Regenerates either the primary or secondary admin API key.
abstract int	replicaCount()
abstract Sku	sku()
abstract SearchServiceStatus	status() The status of the Search service.
abstract String	statusDetails()

Method Details

createQueryKey

public abstract 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

createQueryKeyAsync

public abstract Mono 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

deleteQueryKey

public abstract 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.

deleteQueryKeyAsync

public abstract Mono 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

getAdminKeys

public abstract AdminKeys getAdminKeys()

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

Returns:

the AdminKeys object if successful

getAdminKeysAsync

public abstract Mono getAdminKeysAsync()

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

Returns:

a representation of the future computation of this call

hostingMode

public abstract 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 abstract PagedIterable listQueryKeys()

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

Returns:

the List<QueryKey> object if successful

listQueryKeysAsync

public abstract PagedFlux listQueryKeysAsync()

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

Returns:

the observable to the List<QueryKey> object

partitionCount

public abstract int partitionCount()

Returns:

the number of partitions used by the service

provisioningState

public abstract 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

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Whether the search service can be accessed from public network.

Returns:

whether the search service can be accessed from public network.

regenerateAdminKeys

public abstract 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

regenerateAdminKeysAsync

public abstract Mono 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

replicaCount

public abstract int replicaCount()

Returns:

the number of replicas used by the service

sku

public abstract Sku sku()

Returns:

the SKU type of the service

status

public abstract 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 abstract String statusDetails()

Returns:

the details of the status.