Package com.azure.resourcemanager.search.fluent.models

Class SearchServiceProperties

java.lang.Object
com.azure.resourcemanager.search.fluent.models.SearchServiceProperties
public final class SearchServiceProperties extends Object
Properties of the search service.

  • Constructor Details

    • SearchServiceProperties

      public SearchServiceProperties()
      Creates an instance of SearchServiceProperties class.

  • Method Details

    • replicaCount

      public Integer replicaCount()
      Get the replicaCount property: The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
      Returns:
      the replicaCount value.

    • withReplicaCount

      public SearchServiceProperties withReplicaCount(Integer replicaCount)
      Set the replicaCount property: The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
      Parameters:
      replicaCount - the replicaCount value to set.
      Returns:
      the SearchServiceProperties object itself.

    • partitionCount

      public Integer partitionCount()
      Get the partitionCount property: The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
      Returns:
      the partitionCount value.

    • withPartitionCount

      public SearchServiceProperties withPartitionCount(Integer partitionCount)
      Set the partitionCount property: The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
      Parameters:
      partitionCount - the partitionCount value to set.
      Returns:
      the SearchServiceProperties object itself.

    • hostingMode

      public HostingMode hostingMode()
      Get the hostingMode property: 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 hostingMode value.

    • withHostingMode

      public SearchServiceProperties withHostingMode(HostingMode hostingMode)
      Set the hostingMode property: 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'.
      Parameters:
      hostingMode - the hostingMode value to set.
      Returns:
      the SearchServiceProperties object itself.

    • publicNetworkAccess

      public PublicNetworkAccess publicNetworkAccess()
      Get the publicNetworkAccess property: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
      Returns:
      the publicNetworkAccess value.

    • withPublicNetworkAccess

      public SearchServiceProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
      Set the publicNetworkAccess property: This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
      Parameters:
      publicNetworkAccess - the publicNetworkAccess value to set.
      Returns:
      the SearchServiceProperties object itself.

    • status

      public SearchServiceStatus status()
      Get the status property: 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, Microsoft 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 value.

    • statusDetails

      public String statusDetails()
      Get the statusDetails property: The details of the search service status.
      Returns:
      the statusDetails value.

    • provisioningState

      public ProvisioningState provisioningState()
      Get the provisioningState property: 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 provisioningState value.

    • networkRuleSet

      public NetworkRuleSet networkRuleSet()
      Get the networkRuleSet property: Network-specific rules that determine how the search service may be reached.
      Returns:
      the networkRuleSet value.

    • withNetworkRuleSet

      public SearchServiceProperties withNetworkRuleSet(NetworkRuleSet networkRuleSet)
      Set the networkRuleSet property: Network-specific rules that determine how the search service may be reached.
      Parameters:
      networkRuleSet - the networkRuleSet value to set.
      Returns:
      the SearchServiceProperties object itself.

    • encryptionWithCmk

      public EncryptionWithCmk encryptionWithCmk()
      Get the encryptionWithCmk property: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
      Returns:
      the encryptionWithCmk value.

    • withEncryptionWithCmk

      public SearchServiceProperties withEncryptionWithCmk(EncryptionWithCmk encryptionWithCmk)
      Set the encryptionWithCmk property: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
      Parameters:
      encryptionWithCmk - the encryptionWithCmk value to set.
      Returns:
      the SearchServiceProperties object itself.

    • disableLocalAuth

      public Boolean disableLocalAuth()
      Get the disableLocalAuth property: When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
      Returns:
      the disableLocalAuth value.

    • withDisableLocalAuth

      public SearchServiceProperties withDisableLocalAuth(Boolean disableLocalAuth)
      Set the disableLocalAuth property: When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
      Parameters:
      disableLocalAuth - the disableLocalAuth value to set.
      Returns:
      the SearchServiceProperties object itself.

    • authOptions

      public DataPlaneAuthOptions authOptions()
      Get the authOptions property: Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
      Returns:
      the authOptions value.

    • withAuthOptions

      public SearchServiceProperties withAuthOptions(DataPlaneAuthOptions authOptions)
      Set the authOptions property: Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
      Parameters:
      authOptions - the authOptions value to set.
      Returns:
      the SearchServiceProperties object itself.

    • privateEndpointConnections

      public List<PrivateEndpointConnectionInner> privateEndpointConnections()
      Get the privateEndpointConnections property: The list of private endpoint connections to the search service.
      Returns:
      the privateEndpointConnections value.

    • semanticSearch

      public SearchSemanticSearch semanticSearch()
      Get the semanticSearch property: Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.
      Returns:
      the semanticSearch value.

    • withSemanticSearch

      public SearchServiceProperties withSemanticSearch(SearchSemanticSearch semanticSearch)
      Set the semanticSearch property: Sets options that control the availability of semantic search. This configuration is only possible for certain search SKUs in certain locations.
      Parameters:
      semanticSearch - the semanticSearch value to set.
      Returns:
      the SearchServiceProperties object itself.

    • sharedPrivateLinkResources

      public List<SharedPrivateLinkResourceInner> sharedPrivateLinkResources()
      Get the sharedPrivateLinkResources property: The list of shared private link resources managed by the search service.
      Returns:
      the sharedPrivateLinkResources value.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.