Class CreateDeliverabilityTestOptions

Create a new deliverability/load test

Inheritance

object

CreateDeliverabilityTestOptions

Implements

IValidatableObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "CreateDeliverabilityTestOptions")]
public class CreateDeliverabilityTestOptions : IValidatableObject

Constructors

CreateDeliverabilityTestOptions()

Initializes a new instance of the CreateDeliverabilityTestOptions class.

Declaration

[JsonConstructor]
protected CreateDeliverabilityTestOptions()

CreateDeliverabilityTestOptions(string, string, ScopeEnum, DateTime?, long?, double?, DeliverabilitySelectorOptions, List<DeliverabilityExpectation>)

Initializes a new instance of the CreateDeliverabilityTestOptions class.

Declaration

public CreateDeliverabilityTestOptions(string name = null, string description = null, CreateDeliverabilityTestOptions.ScopeEnum scope = (CreateDeliverabilityTestOptions.ScopeEnum)0, DateTime? startAt = null, long? maxDurationSeconds = null, double? successThresholdPercent = null, DeliverabilitySelectorOptions selector = null, List<DeliverabilityExpectation> expectations = null)

Parameters

Type	Name	Description
string	name	Optional name for the test.
string	description	Optional description.
CreateDeliverabilityTestOptions.ScopeEnum	scope	Entity scope to evaluate (required).
DateTime?	startAt	UTC instant when the receive window starts. Defaults to now if omitted..
long?	maxDurationSeconds	Optional timeout in seconds after startAt. If not all entities match before timeout the test transitions to FAILED..
double?	successThresholdPercent	Optional acceptable success threshold percentage (0,100]. If set, a timed-out test can complete successfully when matchedEntities/totalEntities reaches this percentage..
DeliverabilitySelectorOptions	selector	selector (required).
List<DeliverabilityExpectation>	expectations	One or more expectations to evaluate for each entity (required).

Properties

Description

Optional description

Declaration

[DataMember(Name = "description", EmitDefaultValue = true)]
public string Description { get; set; }

Property Value

Type	Description
string	Optional description

Expectations

One or more expectations to evaluate for each entity

Declaration

[DataMember(Name = "expectations", IsRequired = true, EmitDefaultValue = true)]
public List<DeliverabilityExpectation> Expectations { get; set; }

Property Value

Type	Description
List<DeliverabilityExpectation>	One or more expectations to evaluate for each entity

MaxDurationSeconds

Optional timeout in seconds after startAt. If not all entities match before timeout the test transitions to FAILED.

Declaration

[DataMember(Name = "maxDurationSeconds", EmitDefaultValue = true)]
public long? MaxDurationSeconds { get; set; }

Property Value

Type	Description
long?	Optional timeout in seconds after startAt. If not all entities match before timeout the test transitions to FAILED.

Name

Optional name for the test

Declaration

[DataMember(Name = "name", EmitDefaultValue = true)]
public string Name { get; set; }

Property Value

Type	Description
string	Optional name for the test

Scope

Entity scope to evaluate

Declaration

[DataMember(Name = "scope", IsRequired = true, EmitDefaultValue = true)]
public CreateDeliverabilityTestOptions.ScopeEnum Scope { get; set; }

Property Value

Type	Description
CreateDeliverabilityTestOptions.ScopeEnum	Entity scope to evaluate

Selector

Gets or Sets Selector

Declaration

[DataMember(Name = "selector", IsRequired = true, EmitDefaultValue = true)]
public DeliverabilitySelectorOptions Selector { get; set; }

Property Value

Type	Description
DeliverabilitySelectorOptions

StartAt

UTC instant when the receive window starts. Defaults to now if omitted.

Declaration

[DataMember(Name = "startAt", EmitDefaultValue = true)]
public DateTime? StartAt { get; set; }

Property Value

Type	Description
DateTime?	UTC instant when the receive window starts. Defaults to now if omitted.

SuccessThresholdPercent

Optional acceptable success threshold percentage (0,100]. If set, a timed-out test can complete successfully when matchedEntities/totalEntities reaches this percentage.

Declaration

[DataMember(Name = "successThresholdPercent", EmitDefaultValue = true)]
public double? SuccessThresholdPercent { get; set; }

Property Value

Type	Description
double?	Optional acceptable success threshold percentage (0,100]. If set, a timed-out test can complete successfully when matchedEntities/totalEntities reaches this percentage.

Methods

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
string	String presentation of the object

Overrides

object.ToString()

Implements

IValidatableObject