CollectionSet Class
The CollectionSet class is derived from SFC::SfcInstanceBase and implements SFC::ICreatable, SFC::IDropable, and SFC::IAlterable.
Assembly: Microsoft.SqlServer.Management.Collector (in Microsoft.SqlServer.Management.Collector.dll)
Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
Microsoft.SqlServer.Management.Collector.CollectionSet
| Name | Description | |
|---|---|---|
 | CollectionSet() | Instantiates a collection set object. |
| CollectionSet(CollectorConfigStore, String) | Initialize an instance of a T:CollectionSet given a T:CollectorConfigStore object as a parent and a collection set name. |
| Name | Description | |
|---|---|---|
 | AbstractIdentityKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
 | CollectionItems | Gets the collection items in a collection set. |
| CollectionMode | Gets or sets the collection mode for the collection set. |
| DaysUntilExpiration | Gets or sets the number of days that the collected data is saved in the management data warehouse. |
| Description | Gets or sets the description of the collection set. |
| Id | Gets the local ID for the collection set. |
| IdentityKey | Gets the identity key for the collection set. |
| IsRunning | Gets the Boolean property value that indicates whether or not the collection set is running. |
| IsSystem | Gets the Boolean property value that indicates whether or the collection set is a system collection set. |
| IsTransactionPerformance | Gets a value that indicates whether the set is one of defined Transaction Performance collection sets. |
| LoggingLevel | Gets or sets the logging level for the collection set. |
| Metadata | Returns metadata about the instance and its domain.(Inherited from SfcInstance.) |
| Name | Gets or sets the name of the collection set. |
| Parent | Gets or sets the parent store that this collection set belongs to. |
| Properties | Returns a collection instance properties.(Inherited from SfcInstance.) |
| ProxyName | Gets or sets the name of the SQL Server Agent proxy account under which the collection set executes. |
| ScheduleName | Gets or sets the name of the SQL Server Agent schedule that is associated to the collection set. |
| State | Gets the state of the collection set. |
| TargetName | Gets or sets the name of the target that the collection set will collect data from. |
| UId | Gets or sets the globally unique ID for the collection set. |
| Urn | Returns the uniform resource name of the SfcInstance object.(Inherited from SfcInstance.) |
| Name | Description | |
|---|---|---|
| Alter() | Alter collection set information in the configuration store. |
| Cleanup() | Cleans up all activities done while configuring this collection set. |
| Create() | Creates a collection set. |
 | CreateIdentityKey() | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
| Discover(ISfcDependencyDiscoveryObjectSink) | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
| Drop() | Drops a collection set. |
| EnumCollectionSetExecutionHistory() | An enumerator that gets the history records for specific collection set. |
| EnumCollectionSetExecutionHistory(Int64) | This method is for internal use only. |
| EnumCollectionSetExecutionHistoryDetail(Int64) | This method is for internal use only. |
| Equals(Object) | (Inherited from Object.) |
| GetChildCollection(String) | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
| GetDomain() | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
| GetHashCode() | (Inherited from Object.) |
| GetLastUploadTime() | Gets the last time that collection set data was uploaded. |
 | GetObjectFactory() | Gets the object factory constructor for the CollectorConfigStore object. |
| GetPropertySet() | Returns the set of properties for the SfcInstance object.(Inherited from SfcInstance.) |
| GetType() | (Inherited from Object.) |
| GetTypeMetadataImpl() | Indicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
| InitializeUIPropertyState() | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
| OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) | Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.) |
| OnPropertyValueChanges(PropertyChangedEventArgs) | Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.) |
| Refresh() | Refreshes the object's properties by reading them from the server.(Inherited from SfcInstance.) |
| Rename(String) | Renames a collection set. |
| ResetKey() | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
| RunOnce() | Specifies the collection set is to be run once. |
| ScriptAlter() | This method is for internal use only. |
| Serialize(XmlWriter) | Serializes the instance to XML.(Inherited from SfcInstance.) |
| Start() | Starts a collection set. |
| Stop() | Stops a collection set. |
| ToString() | Returns a string representation of the instance Urn.(Inherited from SfcInstance.) |
| Upload() | Uploads a collection set on demand. |
| Name | Description | |
|---|---|---|
 | PropertyChanged | Occurs when a property value changes.(Inherited from SfcInstance.) |
| PropertyMetadataChanged | Occurs when the metadata for a property has changed.(Inherited from SfcInstance.) |
| Name | Description | |
|---|---|---|
  | ISfcCreatable.ScriptCreate() | Produces the script to create this object to storage in its current state. Do not reference this member directly in your code. It supports the SQL Server infrastructure. |
| ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink) | Allows the object to indicate relationships for dependency discovery requests via the passed sink. Do not reference this member directly in your code. It supports the SQL Server infrastructure. |
| ISfcDroppable.ScriptDrop() | Produces the script to drop this object from storage. Do not reference this member directly in your code. It supports the SQL Server infrastructure. |
| ISfcRenamable.Rename(SfcKey) | Renames this object to the specified key and updates the storage. Do not reference this member directly in your code. It supports the SQL Server infrastructure. |
| ISfcRenamable.ScriptRename(SfcKey) | Produces the script to rename this object to the specified key. Do not reference this member directly in your code. It supports the SQL Server infrastructure. |
This class is used for collection sets.
This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.