Class UsageSummaryRequest

Provides common parameters for the usage summary reports.

Inheritance

object

UsageSummaryRequest

OperationUsageSummaryRequest

ServiceVersionUsageSummaryRequest

Implements

IValidator

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Nevatech.Vsb.Repository.Entities

Assembly: Nevatech.Vsb.Repository.dll

Syntax

[DataContract(Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
public class UsageSummaryRequest : IValidator

Constructors

UsageSummaryRequest()

Declaration

public UsageSummaryRequest()

Properties

ApplicationId

Gets or sets the identifier of the consumer application which transactions need to be included in the report. If not set, all transactions are included.

Declaration

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

Property Value

Type	Description
int?

AuthorizationRuleId

Gets or sets the identifier of the authorization rule that authorized transactions included in the report. If not set, all transactions are included.

Declaration

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

Property Value

Type	Description
int?

ConsumerId

Gets or sets the identifier of the consumer which transactions need to be included in the report. If not set, all transactions are included.

Declaration

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

Property Value

Type	Description
int?

EndDateTime

Gets or sets the exclusive ending of the time interval (in the reporting time zone) when service performance is measured.

Declaration

[DataMember(EmitDefaultValue = false)]
public DateTime? EndDateTime { get; set; }

Property Value

Type	Description
DateTime?

ErrorMessage

Gets the message indicating the errors found during validation process.

Declaration

public string ErrorMessage { get; protected set; }

Property Value

Type	Description
string

Options

Gets or sets the flags defining the scope of data included in the report.

Declaration

[DataMember(EmitDefaultValue = false)]
public UsageSummaryOptions Options { get; set; }

Property Value

Type	Description
UsageSummaryOptions

ProductId

Gets or sets the identifier of the product which transactions need to be included in the report. If not set, all transactions are included.

Declaration

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

Property Value

Type	Description
int?

ReportType

Gets or sets the performance metric that report should be sorted by.

Declaration

[DataMember]
public UsageReportType ReportType { get; set; }

Property Value

Type	Description
UsageReportType

ServiceVersionId

Gets or set the identifier of the service version which transactions need to be included in the report. Parameter is required for Operation Usage Summary report.

Declaration

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

Property Value

Type	Description
int?

StartDateTime

Gets or sets the inclusive beginning of the time interval (in the reporting time zone) when service performance is measured.

Declaration

[DataMember]
public DateTime StartDateTime { get; set; }

Property Value

Type	Description
DateTime

SubscriptionId

Gets or sets the identifier of the consumer subscription which transactions need to be included in the report. If not set, all transactions are included.

Declaration

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

Property Value

Type	Description
int?

TimeUnit

Gets the aggregations time interval to be used for retrieving the data. This property can be read after successfully calling Validate() method.

Declaration

public TimeUnit TimeUnit { get; protected set; }

Property Value

Type	Description
TimeUnit

TopCount

Gets or sets the number of top entities included in the report. If parameter value is zero or less, top 1000 entities will be included.

Declaration

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

Property Value

Type	Description
int

Methods

Validate()

Evaluates the state of the object.

Declaration

public virtual bool Validate()

Returns

Type	Description
bool	True if state is valid; otherwise, false.

Implements

IValidator