Class ServiceAgreementViolationSummaryRequest

Provides filtering criteria for returning service agreement violations summary.

Inheritance

object

ServiceAgreementViolationSummaryRequest

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")]
public sealed class ServiceAgreementViolationSummaryRequest

Constructors

ServiceAgreementViolationSummaryRequest()

Declaration

public ServiceAgreementViolationSummaryRequest()

Properties

EndDateTime

Gets ors sets the end of the time interval when violations occurred (must match the time zone of the corresponding service agreement). If not specified, all violations occured after StartDateTime will be returned.

Declaration

[DataMember]
public DateTime? EndDateTime { 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 the identifier of the folder containing service agreements. If not specified then all folders are considered. If it is set to 0 then only service aggrements in the root folder is considered. Folder and collection of metrics cannot be used together.

Declaration

[DataMember]
public int? FolderId { get; set; }

Property Value

Type	Description
int?

Metrics

Gets collection of service agreement metrics identifiers. All metrics must be defined within the same time zone. At least one metric must be provided, if search by metric is used. At most 10 metrics can be provided. Folder and collection of metrics cannot be used together.

Declaration

[DataMember]
public Collection<int> Metrics { get; }

Property Value

Type	Description
Collection<int>

StartDateTime

Gets or sets the begining of the time interval when violations occurred (must match the time zone of the corresponding service agreement).

Declaration

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

Property Value

Type	Description
DateTime

TimeResolution

Gets or sets the length of the aggregation interval (defined in time inits specified in TimeUnit property).

Declaration

[DataMember]
public int TimeResolution { get; set; }

Property Value

Type	Description
int

TimeUnit

Gets or sets the aggregation interval time measurement unit.

Declaration

[DataMember]
public TimeUnit TimeUnit { get; set; }

Property Value

Type	Description
TimeUnit

TimeZoneId

Gets or sets the time zone identifier of the service agreements which violations need to be returned. This property is required.

Declaration

[DataMember]
public string TimeZoneId { get; set; }

Property Value

Type	Description
string

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.