Class TransactionHeadersRequest

Defines parameters for GetTransactionHeaders(TransactionHeadersRequest) method.

Inheritance
object
TransactionHeadersRequest
Implements
Inherited Members
Namespace: Nevatech.Vsb.Repository.Entities
Assembly: Nevatech.Vsb.Repository.dll
Syntax
[DataContract(Namespace = "http://schemas.nevatech.com/sentinet/2011/02", Name = "TranHdrRequest")]
public sealed class TransactionHeadersRequest : IValidator

Constructors

TransactionHeadersRequest()

Initializes an empty instance.

Declaration
public TransactionHeadersRequest()

Properties

ApplicationId

Gets or sets identifier of the calling application.

Declaration
[DataMember(Name = "AppId", EmitDefaultValue = false)]
public int? ApplicationId { get; set; }
Property Value
Type Description
int?

AuthorizationGroupId

Gets or sets identifier of the authorization group containing the rule that permitted or denied access to the service.

Declaration
[DataMember(EmitDefaultValue = false)]
public int? AuthorizationGroupId { get; set; }
Property Value
Type Description
int?

AuthorizationRuleId

Gets or sets identifier of the authorization rule that matched the transaction and subsequently permitted or denied access to the service.

Declaration
[DataMember(Name = "AuthId", EmitDefaultValue = false)]
public int? AuthorizationRuleId { get; set; }
Property Value
Type Description
int?

ClientAddress

Gets or sets the service caller's IP address for IP-based communication. Wildcards are supported.

Declaration
[DataMember(EmitDefaultValue = false)]
public string ClientAddress { get; set; }
Property Value
Type Description
string

ConsumerId

Gets or sets identifier of the consumer that the calling application belongs to.

Declaration
[DataMember(EmitDefaultValue = false)]
public int? ConsumerId { get; set; }
Property Value
Type Description
int?

EndTimeLocal

Gets or sets date and time when requested time period ends in the reporting time zone. If not set, current time is used.

Declaration
[DataMember(Name = "EndTime", EmitDefaultValue = false)]
public DateTime? EndTimeLocal { get; set; }
Property Value
Type Description
DateTime?

ErrorMessage

Gets validation error message.

Declaration
public string ErrorMessage { get; }
Property Value
Type Description
string

FolderId

Gets or sets identifier of the folder that contains services or nodes generating transactions. If not set then all folders are considered. If set to 0 then root folder is assumed.

Declaration
[DataMember(EmitDefaultValue = false)]
public int? FolderId { get; set; }
Property Value
Type Description
int?

FolderInclusionMode

Gets or sets the type of entity to be searched in the folder and optionally subfolders. Default is IncludesServices.

Declaration
[DataMember(EmitDefaultValue = false)]
public FolderInclusionMode FolderInclusionMode { get; set; }
Property Value
Type Description
FolderInclusionMode

InboundEndpointId

Gets or sets identifier of the service endpoint which was called.

Declaration
[DataMember(EmitDefaultValue = false)]
public int? InboundEndpointId { get; set; }
Property Value
Type Description
int?

InboundServiceVersionId

Gets or sets identifier of the invoked service version.

Declaration
[DataMember(EmitDefaultValue = false)]
public int? InboundServiceVersionId { get; set; }
Property Value
Type Description
int?

IncludeSubfolders

Gets or sets the flag indicating that services or nodes contained in subfolders of the specified folder should also be included. Default is false.

Declaration
[DataMember(EmitDefaultValue = false)]
public bool IncludeSubfolders { get; set; }
Property Value
Type Description
bool

IsVirtual

Gets or sets flag indicating that only virtual or only physical services need to be selected. If False then all services are considered.

Declaration
[DataMember(EmitDefaultValue = false)]
public bool? IsVirtual { get; set; }
Property Value
Type Description
bool?

NodeId

Gets or sets identifier of node that reported transactions.

Declaration
[DataMember(EmitDefaultValue = false)]
public int? NodeId { get; set; }
Property Value
Type Description
int?

NodeInstanceId

Gets or sets identifier of node instance that reported transactions.

Declaration
[DataMember(EmitDefaultValue = false)]
public int? NodeInstanceId { get; set; }
Property Value
Type Description
int?

Operations

Gets collection of identifiers of the calling operations.

Declaration
[DataMember]
public Collection<int> Operations { get; }
Property Value
Type Description
Collection<int>

ProductId

Gets or sets identifier of the product that the calling application belongs to.

Declaration
[DataMember(EmitDefaultValue = false)]
public int? ProductId { get; set; }
Property Value
Type Description
int?

PropertyName

Gets or sets the name of the monitoring transaction property to be associated with the returned transaction(s). Wildcards are supported.

Declaration
[DataMember(EmitDefaultValue = false)]
public string PropertyName { get; set; }
Property Value
Type Description
string

PropertyValue

Gets or sets the value to be found in the monitoring transaction property specified by the PropertyName. If not specified then property must only exist for transaction(s) to be returned.

Declaration
[DataMember(EmitDefaultValue = false)]
public string PropertyValue { get; set; }
Property Value
Type Description
string

RequestAction

Gets or sets the request message Action string for SOAP services or relative request URI for REST services. Wildcards are supported.

Declaration
[DataMember(Name = "Action", EmitDefaultValue = false)]
public string RequestAction { get; set; }
Property Value
Type Description
string

RequestContent

Gets or sets the string to be found in the recorded request message.

Declaration
[DataMember(EmitDefaultValue = false)]
public string RequestContent { get; set; }
Property Value
Type Description
string

ResponseContent

Gets or sets the string to be found in the recorded response message.

Declaration
[DataMember(EmitDefaultValue = false)]
public string ResponseContent { get; set; }
Property Value
Type Description
string

SortField

Gets or sets the field that result will be sorted by.

Declaration
[DataMember]
public TransactionHeadersSortField SortField { get; set; }
Property Value
Type Description
TransactionHeadersSortField

SortOrder

Gets or sets the result sort order.

Declaration
[DataMember]
public SortOrder SortOrder { get; set; }
Property Value
Type Description
SortOrder

StartTimeLocal

Gets or sets date and time when requested time period starts in the reporting time zone.

Declaration
[DataMember(Name = "StartTime")]
public DateTime StartTimeLocal { get; set; }
Property Value
Type Description
DateTime

Status

Gets or sets transaction status. If not set, all transactions will be returned.

Declaration
[DataMember(EmitDefaultValue = false)]
public TransactionStatus? Status { get; set; }
Property Value
Type Description
TransactionStatus?

SubscriptionId

Gets or sets identifier of the subscription that the calling application belongs to.

Declaration
[DataMember(Name = "SubId", EmitDefaultValue = false)]
public int? SubscriptionId { get; set; }
Property Value
Type Description
int?

TransactionId

Gets or sets the logical or business transaction identifier. If property value is provided then all other search parameters are ignored, except for NodeId, InboundServiceVersionId, and FolderId.

Declaration
[DataMember]
public Guid? TransactionId { get; set; }
Property Value
Type Description
Guid?

TransactionType

Gets or sets requested type of the transactions: inbound (recorded by service itself) or outbound (recorded by service clients).

Declaration
[DataMember]
public MonitoringTransactionType TransactionType { get; set; }
Property Value
Type Description
MonitoringTransactionType

Methods

Validate()

Validates object properties returns the result.

Declaration
[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]
public bool Validate()
Returns
Type Description
bool

True, if object state is valid. False, if one or more properties have invalid values.

Implements