CollectionSet Class

  • Article

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

Inheritance Hierarchy

System.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)

Syntax

'Declaration
Public NotInheritable Class CollectionSet _
    Inherits SfcInstance _
    Implements ISfcCreatable, ICreatable, ISfcDroppable, IDroppable,  _
    ISfcAlterable, IAlterable, ISfcRenamable, ISfcDiscoverObject
'Usage
Dim instance As CollectionSet

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

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

[<SealedAttribute>]
type CollectionSet =  
    class 
        inherit SfcInstance 
        interface ISfcCreatable 
        interface ICreatable 
        interface ISfcDroppable 
        interface IDroppable 
        interface ISfcAlterable 
        interface IAlterable 
        interface ISfcRenamable 
        interface ISfcDiscoverObject 
    end

public final class CollectionSet extends SfcInstance implements ISfcCreatable, ICreatable, ISfcDroppable, IDroppable, ISfcAlterable, IAlterable, ISfcRenamable, ISfcDiscoverObject

The CollectionSet type exposes the following members.

Constructors

  Name Description
Public method CollectionSet() Instantiates a collection set object.
Public method CollectionSet(CollectorConfigStore, String) Initialize an instance of a CollectionSet given a CollectorConfigStore object as a parent and a collection set name.

Top

Properties

  Name Description
Protected property AbstractIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public property CollectionItems Gets the collection items in a collection set.
Public property CollectionMode Gets or sets the collection mode for the collection set.
Public property DaysUntilExpiration Gets or sets the number of days that the collected data is saved in the management data warehouse.
Public property Description Gets or sets the description of the collection set.
Public property Id Gets the local ID for the collection set.
Public property IdentityKey Gets the identity key for the collection set.
Public property IsRunning Gets the Boolean property value that indicates whether or not the collection set is running.
Public property IsSystem Gets the Boolean property value that indicates whether or the collection set is a system collection set.
Public property LoggingLevel Gets or sets the logging level for the collection set.
Public property Metadata Returns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public property Name Gets or sets the name of the collection set.
Public property Parent Gets or sets the parent store that this collection set belongs to.
Public property Properties Returns a collection instance properties. (Inherited from SfcInstance.)
Public property ProxyName Gets or sets the name of the SQL Server Agent proxy account under which the collection set executes.
Public property ScheduleName Gets or sets the name of the SQL Server Agent schedule that is associated to the collection set.
Public property State Gets the state of the collection set.
Public property TargetName Gets or sets the name of the target that the collection set will collect data from.
Public property UId Gets or sets the globally unique ID for the collection set.
Public property Urn Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)

Top

Methods

  Name Description
Public method Alter Alter collection set information in the configuration store.
Public method Create Creates a collection set.
Protected method CreateIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Discover Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Drop Drops a collection set.
Public method EnumCollectionSetExecutionHistory() An enumerator that gets the history records for specific collection set.
Public method EnumCollectionSetExecutionHistory(Int64) This method is for internal use only.
Public method EnumCollectionSetExecutionHistoryDetail This method is for internal use only.
Public method Equals (Inherited from Object.)
Protected method GetChildCollection Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetDomain Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetHashCode (Inherited from Object.)
Public method GetLastUploadTime Gets the last time that collection set data was uploaded.
Public methodStatic member GetObjectFactory Gets the object factory constructor for the [CollectorConfigStore] object.
Public method GetPropertySet Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public method GetType (Inherited from Object.)
Protected method 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.)
Protected method InitializeUIPropertyState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method OnPropertyMetadataChanges Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Public method Refresh Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Public method Rename Renames a collection set.
Protected method ResetKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method RunOnce Specifies the collection set is to be run once.
Public method ScriptAlter This method is for internal use only.
Public method Serialize Serializes the instance to XML. (Inherited from SfcInstance.)
Public method Start Starts a collection set.
Public method Stop Stops a collection set.
Public method ToString Returns a string representation of the instance Urn. (Inherited from SfcInstance.)
Public method Upload Uploads a collection set on demand.

Top

Events

  Name Description
Public event PropertyChanged CLS-compliant event for property changes. (Inherited from SfcInstance.)
Public event PropertyMetadataChanged CLS-compliant event for property metadata changes. (Inherited from SfcInstance.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method 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.
Explicit interface implemetationPrivate method ISfcDiscoverObject.Discover 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.
Explicit interface implemetationPrivate method 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.
Explicit interface implemetationPrivate method ISfcRenamable.Rename 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.
Explicit interface implemetationPrivate method ISfcRenamable.ScriptRename 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.

Top

Remarks

This class is used for collection sets.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Collector Namespace