Class AstMessageQueueTaskNode
The Message Queue task can send and receive messages between SSIS packages or to an application queue processed by a custom application. The messages can contain simple text, files, or variables and values.
Namespace: Varigence.Languages.Biml.Task
Assembly: Biml.dll
public class AstMessageQueueTaskNode : AstTaskBaseNode, IBindableItem, IVulcanCollectionParent, IVulcanNotifyPropertyChanged, IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, INotifyPropertyChanged, IXObjectMappingProvider, IValidationInfo, IDataErrorInfo, INamedItem, IScopedNameIndexable, IDataflowItem
- Inheritance
-
System.ObjectAstMessageQueueTaskNode
Implements
IBindableItem, Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, IValidationInfo, System.ComponentModel.IDataErrorInfo, INamedItem, Varigence.Utility.Collections.IScopedNameIndexable, IDataflowItem,
Constructors
| Name | Description |
|---|---|
| AstMessageQueueTaskNode(IFrameworkItem) | Initializes a new instance of the AstMessageQueueTaskNode class with the specified parent node. |
Properties
| Name | Description |
|---|---|
| DataFileOverWritable | This value specifies whether a data file message is allowed to overwrite an existing data file. |
| DataFileOverWritableDefaultValue | Gets the default value for the DataFileOverWritable property |
| EncryptionAlgorithm | This value specifies the encryption algorithm use to encrypt a private message. |
| EncryptionAlgorithmDefaultValue | Gets the default value for the EncryptionAlgorithm property |
| ErrorIfMessageTimeout | This value specifies whether the task fails if a message times out. |
| ErrorIfMessageTimeoutDefaultValue | Gets the default value for the ErrorIfMessageTimeout property |
| FriendlyTypeName | Gets the friendly name of the type of this node |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| MsmqConnection | This value specifies the Message Queing (MSMQ) connection to use to connect to a message queue. |
| ReceiveMessage | This value specifies how the message will be stored, using one of the available resources. |
| ReceiveMessageFromPackageFilter | This value specifies whether the task receives messages only from a specified package. |
| ReceiveMessageFromPackageFilterDefaultValue | Gets the default value for the ReceiveMessageFromPackageFilter property |
| ReceiveMessageTimeout | This value specifies the maximum number of seconds allowed before a received message times out. |
| ReceiveMessageTimeoutDefaultValue | Gets the default value for the ReceiveMessageTimeout property |
| RemoveFromQueue | This value specifies whether a message should be removed from the queue. |
| RemoveFromQueueDefaultValue | Gets the default value for the RemoveFromQueue property |
| SendMessage | This value specifies the source of the message, using one of the available resources. |
| StaticUserDefinedItems | Specifies a collection of items that are common across all instances of the same type in the framework. |
| StringCompareType | This value specifies whether exact, case-insensitive, or substring comparison filter will be applied to messages. |
| StringCompareTypeDefaultValue | Gets the default value for the StringCompareType property |
| StringCompareValue | This value specifies the user-defined string to which a string message is compared. |
| StringCompareValueDefaultValue | Gets the default value for the StringCompareValue property |
| Use2000Format | This value specifies the variable to which string message contents are saved. |
| Use2000FormatDefaultValue | Gets the default value for the Use2000Format property |
| UseEncryption | This value specifies whether the message uses encryption. |
| UseEncryptionDefaultValue | Gets the default value for the UseEncryption property |
Methods
| Name | Description |
|---|---|
| BindingScopeBoundaries() | Retrieves the permitted scope boundaries to bind references from this node. |
| BindReference(SymbolTable, String, Boolean, String, Int32, Boolean) | |
| CopyFrom(IFrameworkItem, UnboundReferences) | Instructs the node to copy property values from the supplied node into itself. This method should only be used by the internal Biml framework. |
| DefinedAstNodes() | Retrieves a collection of nodes that have been defined as direct children of the current node. |
| Duplicate() | Creates a duplicate of the current node |
| Duplicate(Dictionary<IFrameworkItem, IFrameworkItem>) | Creates a duplicate of the current node with the scoped node mapping |
| Duplicate(IFrameworkItem) | Creates a duplicate of the current node with the specified parent item |
| Duplicate(IFrameworkItem, Dictionary<IFrameworkItem, IFrameworkItem>) | Creates a duplicate of the current node with the specified parent item and scoped node mapping |
| DuplicateHusk(IFrameworkItem) | Creates an empty object into which the values from the current node will be duplicated. This method should only be used by the internal Biml framework |
| DuplicateInto(IFrameworkItem, Dictionary<IFrameworkItem, IFrameworkItem>) | Copies the values from the current node into a husk object with the specified scoped node mapping. This method should only be used by the internal Biml framework |
| EmitXmlForAction(AstEnginePropertyAction) | Instructs the node to make changes to its underlying Biml code that correspond to the provided action. This method should only be used by the internal Biml framework. |
| EmitXmlForProperty(String, Int32) | Instructs the node to make changes to its underlying Biml code that correspond to the provided property and index. This method should only be used by the internal Biml framework. |
| ForceNull(String, Int32) | Internal method used by the compiler to make a propert value null when required by the binding framework. |
| GetAllItemsReferencedByDefinedSuccessors() | Builds a list of all items referenced by this node and its successors. Each tuple in the returned list represents a FrameworkItemReference. The first item is the ReferencingItem, the second item is the property name, and the third item is the ReferencedItem. |
| GetBimlAttributeFragment(CulturedStringBuilder) | |
| GetBimlChildFragment(CulturedStringBuilder, Int32) | |
| GetBimlFragment(CulturedStringBuilder, Int32, Boolean) | Internal method used by the Biml engine to produce the XML code for the current object. |
| GetDefaultValue(String) | Retrieves the default value for the property with the name propertyName |
| GetDefaultValue<T>(String) | Retrieves the default value for the property with the name propertyName |
| GetJson(StringBuilder, ref Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean) | Generates a JavaScript Object Notation (JSON) representation of the current node |
| GetPotentialParentProperties() | Retrieves the reflection information for related properties of this node type. |
| GetPropertyValue(String) | Retrieves the current value for the property with the name propertyName |
| GetReflectionInfoFromXmlParsePath(String) | Retrieves the reflection information corresponding to the Xml parse path beginning at this node. |
| HasAnyBimlChildNodes() | |
| MergeFrom(IFrameworkItem, UnboundReferences, Boolean) | Instructs the node to merge property values from the supplied node into itself. This method should only be used by the internal Biml framework. |
| ParseAttribute(XAttribute, ParserContext) | |
| ParseChild(XElement, ParserContext) | |
| StructureEquals(Object) | Compares this node to the provided object to determine if all defined children and references are equal. |
| Validate(ValidationReporter) | Retrieves a collection of validation and diagnostic messages for the current node. |