Export (0) Print
Expand All

CollectionSet Class

The CollectionSet class is derived from SFC::SfcInstanceBase and implements SFC::ICreatable, SFC::IDropable, and SFC::IAlterable.

Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.Collector.CollectionSet

Namespace:  Microsoft.SqlServer.Management.Collector
Assembly:  Microsoft.SqlServer.Management.Collector (in Microsoft.SqlServer.Management.Collector.dll)

public sealed class CollectionSet : SfcInstance, 
	ISfcCreatable, ICreatable, ISfcDroppable, IDroppable, ISfcAlterable, 
	IAlterable, ISfcRenamable, ISfcDiscoverObject

The CollectionSet type exposes the following members.

  NameDescription
Public methodCollectionSet()Instantiates a collection set object.
Public methodCollectionSet(CollectorConfigStore, String)Initialize an instance of a CollectionSet given a CollectorConfigStore object as a parent and a collection set name.
Top

  NameDescription
Protected propertyAbstractIdentityKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public propertyCollectionItemsGets the collection items in a collection set.
Public propertyCollectionModeGets or sets the collection mode for the collection set.
Public propertyDaysUntilExpirationGets or sets the number of days that the collected data is saved in the management data warehouse.
Public propertyDescriptionGets or sets the description of the collection set.
Public propertyIdGets the local ID for the collection set.
Public propertyIdentityKeyGets the identity key for the collection set.
Public propertyIsRunningGets the Boolean property value that indicates whether or not the collection set is running.
Public propertyIsSystemGets the Boolean property value that indicates whether or the collection set is a system collection set.
Public propertyIsTransactionPerformanceGets a value that indicates whether the set is one of defined Transaction Performance collection sets.
Public propertyLoggingLevelGets or sets the logging level for the collection set.
Public propertyMetadataReturns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public propertyNameGets or sets the name of the collection set.
Public propertyParentGets or sets the parent store that this collection set belongs to.
Public propertyPropertiesReturns a collection instance properties. (Inherited from SfcInstance.)
Public propertyProxyNameGets or sets the name of the SQL Server Agent proxy account under which the collection set executes.
Public propertyScheduleNameGets or sets the name of the SQL Server Agent schedule that is associated to the collection set.
Public propertyStateGets the state of the collection set.
Public propertyTargetNameGets or sets the name of the target that the collection set will collect data from.
Public propertyUIdGets or sets the globally unique ID for the collection set.
Public propertyUrnReturns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)
Top

  NameDescription
Public methodAlterAlter collection set information in the configuration store.
Public methodCleanupCleans up all activities done while configuring this collection set.
Public methodCreateCreates a collection set.
Protected methodCreateIdentityKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodDiscoverDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodDropDrops a collection set.
Public methodEnumCollectionSetExecutionHistory()An enumerator that gets the history records for specific collection set.
Public methodEnumCollectionSetExecutionHistory(Int64)This method is for internal use only.
Public methodEnumCollectionSetExecutionHistoryDetailThis method is for internal use only.
Public methodEquals (Inherited from Object.)
Protected methodGetChildCollectionDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodGetDomainDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLastUploadTimeGets the last time that collection set data was uploaded.
Public methodStatic memberGetObjectFactoryGets the object factory constructor for the [CollectorConfigStore] object.
Public methodGetPropertySetReturns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public methodGetType (Inherited from Object.)
Protected methodGetTypeMetadataImplIndicates 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.)
Protected methodInitializeUIPropertyStateDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodOnPropertyMetadataChangesInvoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected methodOnPropertyValueChangesInvoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Public methodRefreshRefreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Public methodRenameRenames a collection set.
Protected methodResetKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodRunOnceSpecifies the collection set is to be run once.
Public methodScriptAlterThis method is for internal use only.
Public methodSerializeSerializes the instance to XML. (Inherited from SfcInstance.)
Public methodStartStarts a collection set.
Public methodStopStops a collection set.
Public methodToStringReturns a string representation of the instance Urn. (Inherited from SfcInstance.)
Public methodUploadUploads a collection set on demand.
Top

  NameDescription
Public eventPropertyChangedCLS-compliant event for property changes. (Inherited from SfcInstance.)
Public eventPropertyMetadataChangedCLS-compliant event for property metadata changes. (Inherited from SfcInstance.)
Top

  NameDescription
Explicit interface implemetationPrivate methodISfcCreatable.ScriptCreateProduces 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.
Explicit interface implemetationPrivate methodISfcDiscoverObject.DiscoverAllows 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.
Explicit interface implemetationPrivate methodISfcDroppable.ScriptDropProduces the script to drop this object from storage. Do not reference this member directly in your code. It supports the SQL Server infrastructure.
Explicit interface implemetationPrivate methodISfcRenamable.RenameRenames 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.
Explicit interface implemetationPrivate methodISfcRenamable.ScriptRenameProduces 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.
Top

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft