[DataContract(Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
public class Parameter : IValidator, IEquatable<Parameter>, IExtensibleDataObject

Constructors

Parameter()

Initializes an empty instance.

Declaration

public Parameter()

Properties

ArrayFormat

Gets or sets the format of the array, if Array type is used.

Declaration

[DataMember(EmitDefaultValue = false)]
public ParameterArrayFormat? ArrayFormat { get; set; }

Property Value

Type	Description
ParameterArrayFormat?

ArrayItem

Gets or sets the description of the type of items in the array, if Array type is used.

Declaration

[DataMember(EmitDefaultValue = false)]
public Parameter ArrayItem { get; set; }

Property Value

Type	Description
Parameter

ArrayMaximumItems

Gets or sets the maximum size of the array. The number of items must be less than, or equal to, the value of this property.

Declaration

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

Property Value

Type	Description
int?

ArrayMinimumItems

Gets or sets the minimum size of the array. The number of items must be greater than, or equal to, the value of this property.

Declaration

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

Property Value

Type	Description
int?

DataFormat

Gets or sets the extending format for the previously mentioned type. The examples are: "int32", "int64", "float", "byte", "binary", "date", "date-time", "password".

Declaration

[DataMember(EmitDefaultValue = false)]
public string DataFormat { get; set; }

Property Value

Type	Description
string

DataType

Gets or sets the value data type.

Declaration

[DataMember]
public ParameterDataType DataType { get; set; }

Property Value

Type	Description
ParameterDataType

DefaultValue

Gets or sets the value of the parameter that the server will use if none is provided.

Declaration

[DataMember(EmitDefaultValue = false)]
public string DefaultValue { get; set; }

Property Value

Type	Description
string

ErrorMessage

Gets the summary of validation errors.

Declaration

public string ErrorMessage { get; protected set; }

Property Value

Type	Description
string

ExtensionData

Gets or sets ExtensionDataObject that enables serialization roundtrips.

Declaration

public ExtensionDataObject ExtensionData { get; set; }

Property Value

Type	Description
ExtensionDataObject

IsArrayUnique

Gets or sets the flag indicating that all items of the array must be unique.

Declaration

[DataMember(EmitDefaultValue = false)]
public bool? IsArrayUnique { get; set; }

Property Value

Type	Description
bool?

IsEmptyValueAllowed

Gets or sets flag that sets the ability to pass empty-valued parameters. This is valid only for either "query" or "formData" parameters and allows you to send a parameter with a name only or an empty value.

Declaration

[DataMember(EmitDefaultValue = false)]
public bool IsEmptyValueAllowed { get; set; }

Property Value

Type	Description
bool

IsExclusiveMaximum

Gets or sets the flag indicating that value must be strictly lower than MaximumValue.

Declaration

[DataMember(EmitDefaultValue = false)]
public bool IsExclusiveMaximum { get; set; }

Property Value

Type	Description
bool

IsExclusiveMinimum

Gets or sets the flag indicating that value must be strictly greater than MinimumValue.

Declaration

[DataMember(EmitDefaultValue = false)]
public bool IsExclusiveMinimum { get; set; }

Property Value

Type	Description
bool

IsRequired

Gets or sets flag indicating whether this parameter is mandatory. If the parameter is in "path", this property is required and its value MUST be true.

Declaration

[DataMember(EmitDefaultValue = false)]
public bool IsRequired { get; set; }

Property Value

Type	Description
bool

MaximumLength

Gets or sets the maximum string length of the value. The value length must be less than, or equal to, the value of this property.

Declaration

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

Property Value

Type	Description
int?

MaximumValue

Gets or sets the maximum value of the parameter.

Declaration

[DataMember(EmitDefaultValue = false)]
public decimal? MaximumValue { get; set; }

Property Value

Type	Description
decimal?

MinimumLength

Gets or sets the minimum string length of the value. The value length must be greater than, or equal to, the value of this property.

Declaration

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

Property Value

Type	Description
int?

MinimumValue

Gets or sets the minimum value of the parameter.

Declaration

[DataMember(EmitDefaultValue = false)]
public decimal? MinimumValue { get; set; }

Property Value

Type	Description
decimal?

MultipleOf

Gets or sets the positive, greater than zero number to be used to check, if the division of the parameter value by this number is an integer.

Declaration

[DataMember(EmitDefaultValue = false)]
public decimal? MultipleOf { get; set; }

Property Value

Type	Description
decimal?

Pattern

Gets or sets the regular expression that should match the parameter value.

Declaration

[DataMember(EmitDefaultValue = false)]
public string Pattern { get; set; }

Property Value

Type	Description
string

Schema

Gets or sets the reference to (name of) JSON schema type that describes the parameter structure. This property is used for complex types only.

Declaration

[DataMember(EmitDefaultValue = false)]
public string Schema { get; set; }

Property Value

Type	Description
string

Values

Gets collection of permitted values that can be used with this parameter. If empty then no restriction is applied.

Declaration

[DataMember]
public Collection<string> Values { get; }

Property Value

Type	Description
Collection<string>

Methods

CopyFrom(Parameter)

Populates this instance from the provided parameter.

Declaration

public virtual void CopyFrom(Parameter parameter)

Parameters

Type	Name	Description
Parameter	parameter	Parameter to copy properties from.

Equals(Parameter)

Determines whether the specified object is equal to the current object.

Declaration

[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]
public virtual bool Equals(Parameter other)

Parameters

Type	Name	Description
Parameter	other	The object to compare with the current object.

Returns

Type	Description
bool	True, if objects are equal. False, if objects are not equal.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	True, if objects are equal. False, if objects are not equal.

Overrides

object.Equals(object)

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Hash code of the current instance.

Overrides

object.GetHashCode()

ToString()

Returns the text representation of the object.

Declaration

public override string ToString()

Returns

Type	Description
string	Text description of the object.

Overrides

object.ToString()

Validate()

Evaluates the state of this object.

Declaration

[SuppressMessage("Microsoft.Performance", "CA1820:TestForEmptyStringsUsingStringLength")]
[SuppressMessage("Microsoft.Usage", "CA1806:DoNotIgnoreMethodResults", MessageId = "System.Text.RegularExpressions.Regex")]
[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]
public virtual bool Validate()

Returns

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

Implements

IValidator

IEquatable<T>

IExtensibleDataObject