SearchServiceApplication Members

  • Article

Include Protected Members
Include Inherited Members

Provides an SPIisWebServiceApplication that allows for administration and management of Search components on a server.

The SearchServiceApplication type exposes the following members.

Constructors

  Name Description
Public method SearchServiceApplication Initializes a new instance of the SearchServiceApplication class.

Top

Properties

  Name Description
Protected property AccessRights (Inherited from SPIisWebServiceApplication.)
Public property AdminComponent Gets the component that provides the ability to administer the SearchServiceApplication.
Protected property AdministrationAccessRights (Inherited from SPServiceApplication.)
Public property AlertNotificationFormat Gets or sets the e-mail format of the alert.
Public property AlertNotificationQuota Gets or sets the quota of the alerts for the current SearchServiceApplication.
Public property AlertsEnabled Gets or sets a value that indicates whether alerts are enabled in the current SearchServiceApplication.
Public property ApplicationClassId Gets the GUID that represents the SearchServiceApplication class ID. (Overrides SPServiceApplication.ApplicationClassId.)
Public property ApplicationName Gets the name of the SearchServiceApplication, which is a GUID that has been converted to a string.
Public property ApplicationPool (Inherited from SPIisWebServiceApplication.)
Public property ApplicationVersion (Inherited from SPServiceApplication.)
Public property CanUpgrade (Inherited from SPPersistedUpgradableObject.)
Public property Comments (Inherited from SPIisWebServiceApplication.)
Public property CrawlStores Gets all of the CrawlStoreCollection objects that are managed by the current SearchServiceApplication.
Public property CrawlTopologies Gets the CrawlTopologyCollection that is managed by the current SearchServiceApplication.
Public property DefaultEndpoint (Inherited from SPIisWebServiceApplication.)
Protected property DefaultEndpointName Gets the name of the default endpoint of the current SearchServiceApplication. (Overrides SPIisWebServiceApplication.DefaultEndpointName.)
Public property DefaultSearchProvider Gets or sets the default Search provider that provides the data in response to a query.
Public property DiacriticSensitive Gets or sets a flag that indicates whether the Search service is configured to be diacritic sensitive.
Public property DisplayName (Inherited from SPPersistedObject.)
Public property Endpoints (Inherited from SPIisWebServiceApplication.)
Public property ExtendedConnectorProperties Gets a ExtendedConnectorPropertyCollection of the FAST Search Content Search Service Application connector, which provides custom content to the FAST Search Service.
Public property Farm (Inherited from SPPersistedObject.)
Public property FarmIdsForAlerts Gets or sets the list of farm IDs to be notified when alerts are raised by the current SearchServiceApplication.
Public property FASTAdminProxy Gets an object that can be used to access WCF administration services on a server running FAST Search Server 2010 for SharePoint.
Public property Id (Inherited from SPPersistedObject.)
Public property IisVirtualDirectoryPath (Inherited from SPIisWebServiceApplication.)
Protected property InstallPath Gets the fully qualified installation path of the current SearchServiceApplication. (Overrides SPIisWebServiceApplication.InstallPath.)
Public property IsBackwardsCompatible (Inherited from SPPersistedUpgradableObject.)
Public property LocationConfigurations Gets the LocationConfigurationCollection for a federated Search location.
Public property ManageLink Gets the link to the administration page that is used to manage the current SearchServiceApplication. (Overrides SPServiceApplication.ManageLink.)
Public property MinimumReadyQueryComponentsPerPartition Gets or sets the minimum number of the query components used in each index partition.
Public property Name (Inherited from SPPersistedObject.)
Public property NeedsUpgrade (Inherited from SPPersistedUpgradableObject.)
Public property NeedsUpgradeIncludeChildren (Inherited from SPPersistedUpgradableObject.)
Public property Parent (Inherited from SPPersistedObject.)
Public property PermissionsLink (Inherited from SPIisWebServiceApplication.)
Public property Properties (Inherited from SPPersistedObject.)
Public property PropertiesLink Gets the link to the properties editing page of the current SearchServiceApplication. (Overrides SPServiceApplication.PropertiesLink.)
Public property PropertyStores Gets the PropertyStoreCollection that is used by the current SearchServiceApplication.
Public property QueryLoggingEnabled Gets or sets a flag that indicates whether query logging is enabled for the current SearchServiceApplication.
Public property QuerySuggestionsEnabled Gets or sets a flag that indicates whether query suggestions is enabled for the current SearchServiceApplication.
Public property QueryTopologies Gets a QueryTopologyCollection in the SearchServiceApplication.
Public property ResetAndEnableAlerts Gets or sets a flag that indicates whether to reset and enable alerts when the current SearchServiceApplication is reset.
Public property SearchAdminDatabase Gets or sets the SearchAdminDatabase of the current SearchServiceApplication.
Public property SearchApplicationType Gets the type of the current SearchServiceApplication.
Public property Service (Inherited from SPServiceApplication.)
Public property ServiceApplicationProxyGroup (Inherited from SPServiceApplication.)
Public property ServiceInstances (Inherited from SPServiceApplication.)
Public property Shared (Inherited from SPIisWebServiceApplication.)
Public property Status (Inherited from SPPersistedObject.)
Public property TempPath Gets or sets the temporary path of the SearchServiceApplication.
Public property TermsOfServiceUri (Inherited from SPIisWebServiceApplication.)
Public property TimeBeforeAbandoningQueryComponent Gets or sets the time interval, in milliseconds, to abandon the current query.
Public property TypeName Gets the type name that describes the current SearchServiceApplication. (Overrides SPPersistedObject.TypeName.)
Public property UpgradeContext (Inherited from SPPersistedUpgradableObject.)
Public property UpgradedPersistedProperties (Inherited from SPAutoSerializingObject.)
Public property Uri (Inherited from SPIisWebServiceApplication.)
Public property VerboseQueryMonitoring Gets or sets a flag that indicates whether verbose query logging is turned on for the current SearchServiceApplication.
Public property Version (Inherited from SPPersistedObject.)
Protected property VirtualPath Gets the virtual path of the Search service hosted by Internet Information Services 7.0. (Overrides SPIisWebServiceApplication.VirtualPath.)
Protected property WasCreated (Inherited from SPPersistedObject.)

Top

Methods

  Name Description
Public method AddBestBetLink Adds an association between an existing Best Bet and a keyword to the SearchAdminDatabase.
Public method AddConsumer Adds a Search scope consumer to the SearchAdminDatabase.
Public method AddDisplayGroup Adds a Search scope display group for a Search scope consumer.
Public method AddNewBestBet Adds a new Best Bet for the SearchAdminDatabase.
Public method AddNewLocationConfiguration Adds a new federated location.
Public method AddRule Adds a new Search scope rule to the SearchAdminDatabase.
Public method AddScope Adds a new Search scope to the SearchAdminDatabase.
Public method AddServiceEndpoint(String, SPIisWebServiceBindingType) (Inherited from SPIisWebServiceApplication.)
Public method AddServiceEndpoint(String, SPIisWebServiceBindingType, String) (Inherited from SPIisWebServiceApplication.)
Public method AddSpecialTerm Adds a new keyword to the SearchAdminDatabase.
Public method AddSynonym Adds a synonym for the specified keyword to the SearchAdminDatabase.
Public method BeginProvision (Inherited from SPServiceApplication.)
Public method BeginUnprovision (Inherited from SPServiceApplication.)
Protected method CheckAccess (Inherited from SPIisWebServiceApplication.)
Protected method CheckAdministrationAccess (Inherited from SPServiceApplication.)
Public method Clone (Inherited from SPPersistedObject.)
Public method Delete Deletes the current SearchServiceApplication from the SharePoint Enterprise Search. (Overrides SPIisWebServiceApplication.Delete().)
Public method DeleteConsumer Removes the specified Search scope consumer from the SearchAdminDatabase.
Public method DeleteLocationConfiguration Deletes the federated location from the SearchAdminDatabase.
Protected method DemandAccess (Inherited from SPIisWebServiceApplication.)
Protected method DemandAdministrationAccess (Inherited from SPServiceApplication.)
Public method DropDisplayGroup Deletes the specified ScopeDisplayGroup from the SearchAdminDatabase.
Public method DropRule Deletes the specified SearchScopeRule from the SearchAdminDatabase.
Public method DropScope Deletes the specified Scope from the SearchAdminDatabase.
Public method DropSpecialTerm Deletes the specified Keyword from the SearchAdminDatabase.
Public method DropSynonym Deletes a Synonym of the specified Keyword from the SearchAdminDatabase.
Public method EndProvision (Inherited from SPServiceApplication.)
Public method EndUnprovision (Inherited from SPServiceApplication.)
Public method EnsureTopologyInConfigDB Ensures that the configuration database has been updated with the contents of the databases that are associated with the current SearchServiceApplication.
Public method Equals (Inherited from SPPersistedObject.)
Public method Execute Executes the Search query with the specified query properties.
Protected method Finalize (Inherited from Object.)
Public method ForceResume Forces the SearchServiceApplication to be resumed with the specified reasons.
Public method GetAccessControl (Inherited from SPIisWebServiceApplication.)
Public method GetAdministrationAccessControl (Inherited from SPServiceApplication.)
Public method GetBestBet Retrieves a BestBet for the specified URL and keyword consumer group.
Public method GetBestBetForSpecialTerm Retrieves the information about a BestBet for the specified keyword consumer group, URL, and Keyword.
Public method GetBestBetsCount Calculates the number of BestBet attributes for the specified keyword consumer group that match the specified filtering criteria.
Public method GetBestBetsCountForSpecialTerm Calculates the number of BestBet attributes for the specified Keyword.
Public method GetBestBetsInfo Retrieves all of the BestBet attributes that belong to the specified keyword consumer group.
Public method GetBestBetsInfoForSpecialTerm Retrieves the list of BestBet attributes for the specified Keyword.
Public method GetBestBetsOrderInfoForSpecialTerm Retrieves a list of BestBet attributes associated with the specified Keyword and the information about their priorities within this list.
Public method GetChangedConsumers Retrieves the names of all Search scope consumers that manage a Search scope display group, SearchScope, or SearchScopeRule that has changed since the specified version.
Public method GetChild<T>() (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) (Inherited from SPPersistedObject.)
Public method GetClickFrequenciesForUrl Gets the number of times a specified URL has been clicked in the past week and the past month from the specified date.
Public method GetConsumerInformation
Public method GetConsumers Retrieves a list of the names of all Search scope consumers.
Public method GetContainingDisplayGroups Retrieves a list of SearchScopeDisplayGroup objects that contains the specified Search scope.
Public method GetContentSourceNames Gets a list of ContentSource names managed by the SearchServiceApplication.
Protected method GetDependentProcessIdentities (Inherited from SPServiceApplication.)
Public method GetDisplayGroupIDFromName Retrieves the ID of a SearchScopeDisplayGroup with the specified SearchScopeDisplayGroup name and the Search scope consumer name.
Public method GetDisplayGroupInfo Retrieves information about a SearchScopeDisplayGroup.
Public method GetDisplayGroupListInfo Retrieves a list of display group IDs from the scope display group membership set associated with the specified ScopeDisplayGroup.
Public method GetDisplayGroupsCount Retrieves the total number of SearchScopeDisplayGroup objects.
Public method GetDisplayGroupsForConsumer Retrieves a list of the DisplayGroupInfo objects that is managed by the SearchServiceApplication.
Public method GetDisplayGroupsInfo Retrieves a list of the DisplayGroupInfo objects for each consumer managed by the SearchServiceApplication.
Public method GetHashCode (Inherited from SPPersistedObject.)
Public method GetLastLocationConfigurationUpdate Retrieves the version of the last configuration changes from the Federation Set.
Public method GetLocationConfigurations Retrieves configuration information for all the federated locations.
Public method GetLocationDescription Retrieves the federated location description.
Public method GetLocationVisualizations Retrieves Visualization associated with the specified federated location.
Public method GetManagedProperties Gets a list of ManagedPropertyInfo objects managed by the SearchServiceApplication.
Public method GetObjectData (Inherited from SPAutoSerializingObject.)
Public method GetProperties Returns the PropertyInformation for each property managed by the SearchServiceApplication.
Public method GetProperty Gets the property of the SearchServiceApplication with the specified name.
Public method GetPropertyQueryRuleCount Gets the count of query rules that match a specified property restriction, where the specified property name has the specified property value.
Public method GetProxyInfo Retrieves the SearchProxyInfo information for this SearchServiceApplication.
Public method GetQuerySuggestions Returns a collection of query suggestions that match the specified Search terms.
Public method GetRuleInfo Retrieves the RuleInfo for the ScopeRule with the specified ID.
Public method GetRulesCount Retrieves the count of the SearchScopeRule objects defined for a specified SearchScope in the SearchServiceApplication.
Public method GetRulesInfo Retrieves a list of RuleInfo objects for all of the ScopeRule objects defined within the specified SearchScope.
Public method GetScopeIDFromName Retrieves the ID of a Search scope with the specified name and SearchScope consumer.
Public method GetScopeInfo Retrieves the ScopeInfo for the Scope with the specified ID.
Public method GetScopeRowCount Returns the count of results that match a specified Search scope.
Public method GetScopes Returns the SearchScopeInformation for the Search scope consumer.
Public method GetScopesCount Retrieves the count of all SearchScopes that are defined in the SearchAdminDatabase.
Public method GetScopesForConsumer Retrieves a list of ScopeInfo objects that is managed by the specified Search scope consumer.
Public method GetScopesInfo Retrieves a list of the ScopeInfo objects, which contains one ScopeInfo object for every Scopes object.
Public method GetScopesManagerInfo Retrieves the details of the Search scopes system managed by the SearchServiceApplication.
Public method GetSearchAlertManagerInfo Gets information about the Search alert system.
Public method GetSearchAlertNotificationFormat Gets the notification format of the Search alert system.
Public method GetSearchApplicationDisplayName Returns the display name of the SearchServiceApplication.
Public method GetSearchApplicationName Returns the name of the SearchServiceApplication.
Public method GetSearchServiceApplicationInfo Returns the application information about the SearchServiceApplication.
Public method GetSearchTerms Gets the terms to which keyword Search query has been restricted.
Public method GetSetting Retrieves the value of a Search setting.
Public method GetSharepointLocationVisualizations Retrieves the preselected Visualization objects for the federated location.
Public method GetSpecialTerm Retrieves the Keyword from the SiteCollection given its keyword consumer group, and the keyword term.
Public method GetSpecialTermsCount Calculates the number of KeyWord attributes for the specified KeyWord consumer group.
Public method GetSpecialTermsCountForBestBet Retrieves the number of KeyWord attributes that are associated with the specified BestBet.
Public method GetSpecialTermsInfo Retrieves a dictionary of KeyWord objects from the site collection for a specified KeyWord consumer group.
Public method GetSpecialTermsInfoForBestBet Retrieves the list of KeyWord objects associated with a specified BestBet.
Public method GetSynonym Retrieves the specified Synonym associated with the specified KeyWord.
Public method GetSynonymsCountForSpecialTerm Calculates the number of Synonym objects that are associated with the specified KeyWord.
Public method GetSynonymsInfoSpecialTerm Retrieves the Synonym that is associated with a specified Keyword.
Public method GetTopQueryStringsForUrl Gets a specified number of top query strings used as a result when the user clicks a specified URL.
Public method GetType (Inherited from Object.)
Public method GetUnusedScopesForConsumer Returns a list of DisplayGroupInfo objects, and each object is associated with a Scope.
Public method GetUrlRuleCount Gets the count of crawled items whose site URL matches a specified URL.
Public method GetUserPreferenceSerializeHelper Gets the user preference serialization helper from the SearchAdminDatabase.
Public method GetVisibleScopesCount Gets the count of all visible Scope objects defined in the Search application.
Public method GetVolatileScopeInfo Retrieves the ScopeInfo likely to change for the specified SearchScope.
Public method GetVolatileScopesManagerInfo Retrieves the VolatileScopesManagerInfo that is likely to change for a SearchScopes system in the Search application.
Protected method HasAdditionalUpdateAccess (Inherited from SPServiceApplication.)
Public methodStatic member HasFailures Indicates whether a failure has occurred during a backup or restore operation.
Public method HighlightStringValue Highlights all the occurrences of the specified query terms in a specified string value.
Public method HighlightStringValueQuerySuggestions Highlights all the occurrences of the specified query terms in a specified string value.
Public method Invalidate (Inherited from SPPersistedUpgradableObject.)
Public method IsConnected (Inherited from SPIisWebServiceApplication.)
Public method IsPaused Gets the reasons that crawls are paused.
Protected method MemberwiseClone (Inherited from Object.)
Protected method MigrateGroupAccount (Inherited from SPServiceApplication.)
Protected method MigrateUserAccount (Inherited from SPIisWebServiceApplication.)
Protected method OnDependentProcessIdentityChanged (Inherited from SPServiceApplication.)
Protected method OnDeserialization (Inherited from SPIisWebServiceApplication.)
Protected method OnProcessIdentityChanged Called when the process ID is changed. (Overrides SPIisWebServiceApplication.OnProcessIdentityChanged(SecurityIdentifier).)
Protected method OpenInstanceConfiguration (Inherited from SPIisWebServiceApplication.)
Public method Pause Pauses the SearchServiceApplication.
Public method Provision Provisions the SearchServiceApplication in the server farm. (Overrides SPIisWebServiceApplication.Provision().)
Protected method ProvisionInstances (Inherited from SPServiceApplication.)
Protected method ProvisionLocal (Inherited from SPIisWebServiceApplication.)
Public method PutLocationVisualization Adds a new Visualization definition for the federated location.
Public method RecordClick Records the details of the clickthrough and its corresponding Search query.
Public method RecordOMQueryDoneEvent Records the latency timing information about the executed Search queries.
Public method RecordQueryErrorEvent Records the errors that have occurred during the processing of Search queries.
Public method RecordUIQueryDoneEvent Records the information about the Search query latency on the Search results page.
Public method RecordWebPartQueryDoneEvent Records the Search query latency for a query of Web Parts on the Search results page.
Public method ReEncryptExistingPasswords Reencrypts the existing passwords with a new master key.
Public method RefreshComponents Refreshes the Search components in the SearchServiceApplication.
Public method RemoveBestBetLink Deletes the association between a specified keyword and a BestBet from the SearchAdminDatabase.
Public method ReRunPostRestore Performs the restore operation again after an unsuccessful restore operation of the SearchServiceApplication.
Public method Reset Resets the current SearchServiceApplication.
Public method RestoreDefaultSetting Restores a specified Search setting value to the default value.
Public method Resume Resumes the SearchServiceApplication.
Public method SetAccessControl (Inherited from SPIisWebServiceApplication.)
Public method SetAdministrationAccessControl Applies administration access to the SearchServiceApplication. (Overrides SPServiceApplication.SetAdministrationAccessControl(SPCentralAdministrationSecurity).)
Public method SetBestBetInfo Updates the information about the specified BestBet.
Public method SetCrawlAccountMasterKey Sets the master key that is used to encrypt the crawl account.
Public method SetDisplayGroupInfo Sets the configuration information for the specified SearchScopeDisplayGroup.
Public method SetDisplayGroupListInfo Updates the Search scope display group.
Public method SetProperty Sets the specified property of the SearchServiceApplication.
Public method SetRuleInfo Sets the details of the specified Search scope rule in the SearchServiceApplication.
Public method SetScopeInfo Sets the details of the specified Search scope in the SearchServiceApplication.
Public method SetScopesManagerInfo Sets the SetScopesManagerInfo(ScopesManagerInfo) in the SearchServiceApplication.
Public method SetSpecialTermInfo Updates the information about the specified keyword.
Public method SetUserPreferenceSerializeHelper Sets the user preference serialization helper for a specified user.
Public method StartScopesCompilation Starts the Search scope compilation.
Public method ToString (Inherited from SPPersistedObject.)
Public method Uncache (Inherited from SPPersistedObject.)
Public method Unprovision() (Inherited from SPServiceApplication.)
Public method Unprovision(Boolean) Unprovisions the SearchServiceApplication and optionally deletes data associated with the application. (Overrides SPIisWebServiceApplication.Unprovision(Boolean).)
Protected method UnprovisionInstances (Inherited from SPServiceApplication.)
Protected method UnprovisionLocal (Inherited from SPIisWebServiceApplication.)
Public method Update() Updates the status and properties of the SearchServiceApplication. (Overrides SPIisWebServiceApplication.Update().)
Public method Update(Boolean) (Inherited from SPPersistedObject.)
Public method UpdateBestBetsOrder Updates a series of BestBet attributes that have the specified IDs and the specified keyword.
Public method UpdateLocationConfiguration Updates a federated Search location configuration of the SearchServiceApplication.
Protected method UpdateParent (Inherited from SPAutoSerializingObject.)
Public method UpdateSetting Updates the value of a specified Search setting.
Public method Upgrade() (Inherited from SPPersistedUpgradableObject.)
Public method Upgrade(Boolean) (Inherited from SPPersistedUpgradableObject.)
Protected method Validate (Inherited from SPPersistedObject.)
Public method ValidateBackwardsCompatibility (Inherited from SPPersistedUpgradableObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IBackupRestore.AddBackupObjects (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate property IBackupRestore.CanRenameOnRestore (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate property IBackupRestore.CanSelectForBackup (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate property IBackupRestore.CanSelectForRestore (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate property ISharedServiceApplication.DefaultEndpoint (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate property IBackupRestore.DiskSizeRequired (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate method IBackupRestore.OnAbort (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate method IBackupRestore.OnBackup (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate method IBackupRestore.OnBackupComplete (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate method IBackupRestore.OnPostRestore (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate method IBackupRestore.OnPrepareBackup (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate method IBackupRestore.OnPreRestore (Inherited from SPIisWebServiceApplication.)
Explicit interface implemetationPrivate method IBackupRestore.OnRestore (Inherited from SPIisWebServiceApplication.)

Top

See Also

Reference

SearchServiceApplication Class

Microsoft.Office.Server.Search.Administration Namespace