Package com.azure.resourcemanager.search.models

Class SearchServiceUpdate

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.search.models.SearchServiceUpdate
public class SearchServiceUpdate extends com.azure.core.management.ProxyResource
The parameters used to update an Azure Cognitive Search service.

  • Constructor Details

    • SearchServiceUpdate

      public SearchServiceUpdate()

  • Method Details

    • sku

      public Sku sku()
      Get the sku property: The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.
      Returns:
      the sku value.

    • withSku

      public SearchServiceUpdate withSku(Sku sku)
      Set the sku property: The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.
      Parameters:
      sku - the sku value to set.
      Returns:
      the SearchServiceUpdate object itself.

    • location

      public String location()
      Get the location property: The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.
      Returns:
      the location value.

    • withLocation

      public SearchServiceUpdate withLocation(String location)
      Set the location property: The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.
      Parameters:
      location - the location value to set.
      Returns:
      the SearchServiceUpdate object itself.

    • tags

      public Map<String,String> tags()
      Get the tags property: Tags to help categorize the resource in the Azure portal.
      Returns:
      the tags value.

    • withTags

      public SearchServiceUpdate withTags(Map<String,String> tags)
      Set the tags property: Tags to help categorize the resource in the Azure portal.
      Parameters:
      tags - the tags value to set.
      Returns:
      the SearchServiceUpdate object itself.

    • identity

      public Identity identity()
      Get the identity property: The identity of the resource.
      Returns:
      the identity value.

    • withIdentity

      public SearchServiceUpdate withIdentity(Identity identity)
      Set the identity property: The identity of the resource.
      Parameters:
      identity - the identity value to set.
      Returns:
      the SearchServiceUpdate object itself.

    • 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 SearchServiceUpdate 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 SearchServiceUpdate 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 SearchServiceUpdate 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 SearchServiceUpdate 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 SearchServiceUpdate 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 SearchServiceUpdate 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 SearchServiceUpdate 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 SearchServiceUpdate 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, it means the Azure Cognitive 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 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 Azure Cognitive Search service may be reached.
      Returns:
      the networkRuleSet value.

    • withNetworkRuleSet

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

    • privateEndpointConnections

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

    • sharedPrivateLinkResources

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

    • validate

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