Class TransactionSummaryRequest

Defines parameters for GetTransactionSummary(TransactionSummaryRequest) method.

Inheritance

object

TransactionSummaryRequest

Implements

IValidator

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Nevatech.Vsb.Repository.Entities

Assembly: Nevatech.Vsb.Repository.dll

Syntax

[DataContract(Namespace = "http://schemas.nevatech.com/sentinet/2011/02", Name = "TranSumRequest")]
public sealed class TransactionSummaryRequest : IValidator

Constructors

TransactionSummaryRequest()

Initializes an empty instance.

Declaration

public TransactionSummaryRequest()

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?

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 = "End", EmitDefaultValue = false)]
public DateTime? EndTimeLocal { get; set; }

Property Value

Type	Description
DateTime?

EndpointId

Gets or sets the identifier of the endpoint that reported transaction.

Declaration

[DataMember(EmitDefaultValue = false)]
public int? EndpointId { get; set; }

Property Value

Type	Description
int?

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

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(Name = "Ops", EmitDefaultValue = false)]
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?

Resolution

Gets or sets time resolution (interval size) that measures should be aggregated into.

Declaration

[DataMember(Name = "Res")]
public int Resolution { get; set; }

Property Value

Type	Description
int

ResolutionUnit

Gets or sets the unit of measurement for the provided Resolution value. The smallest supported time interval in the system is 5 seconds.

Declaration

[DataMember(Name = "Unit")]
public TimeUnit ResolutionUnit { get; set; }

Property Value

Type	Description
TimeUnit

ServiceVersionId

Gets or sets identifier of the invoked service version.

Declaration

[DataMember(Name = "SvcId", EmitDefaultValue = false)]
public int? ServiceVersionId { get; set; }

Property Value

Type	Description
int?

StartTimeLocal

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

Declaration

[DataMember(Name = "Start")]
public DateTime StartTimeLocal { get; set; }

Property Value

Type	Description
DateTime

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?

TransactionType

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

Declaration

[DataMember(Name = "Type")]
public MonitoringTransactionType TransactionType { get; set; }

Property Value

Type	Description
MonitoringTransactionType

Methods

Validate()

Validates object properties returns the result.

Declaration

public bool Validate()

Returns

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

Implements

IValidator