Class OperationInput

Namespace

Microsoft.Accordant

Assembly

Accordant.Operations.dll

This class represents an operation bound with a request, or an operation whose request can be derived from another operation call.

public class OperationInput

Inheritance

object

OperationInput

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Conversions.ToInputFileRecord(OperationInput, ISpec)

Constructors

OperationInput(string, IOperation)

Constructs an instance of this class given a name and an operation. The request is set to an instance of the Unit object to denote the fact that this operation does not take any request.

public OperationInput(string name, IOperation operation)

Parameters

name string

operation IOperation

OperationInput(string, IOperation, IList<OperationCall>, string)

Constructs an instance of this class given a name, an operation and the operation call that this request is derived from.

public OperationInput(string name, IOperation operation, IList<OperationCall> derivedFromOperationCalls, string derivationVariant = "Default")

Parameters

name string

operation IOperation

derivedFromOperationCalls IList<OperationCall>

derivationVariant string

OperationInput(string, IOperation, object)

Constructs an instance of this class given a name, an operation and request.

public OperationInput(string name, IOperation operation, object request)

Parameters

name string

operation IOperation

request object

OperationInput(string, IOperation, object, IList<OperationCall>, string)

Constructs an instance of this class given a name, an operation, a template request and the operation calls this request is derived from.

public OperationInput(string name, IOperation operation, object request, IList<OperationCall> derivedFromOperationCalls, string derivationVariant = "Default")

Parameters

name string

operation IOperation

request object

derivedFromOperationCalls IList<OperationCall>

derivationVariant string

Properties

DerivationVariant

The variant label if this operation's request is derived from other operations. The label is used to identify which variant was generated (e.g., "IfMatch" vs "IfNoneMatch").

public string DerivationVariant { get; set; }

Property Value

string

DerivedFromOperationCalls

The operation calls whose request/response this operation's request is derived from.

public IList<OperationCall> DerivedFromOperationCalls { get; set; }

Property Value

IList<OperationCall>

Name

The name of the operation.

public string Name { get; set; }

Property Value

string

Operation

The operation associated with this input.

public IOperation Operation { get; set; }

Property Value

IOperation

Polling

The polling setup for this input. If set, overrides the operation's Polling property.

public PollingSetup Polling { get; set; }

Property Value

PollingSetup

Request

The request to use when invoking the operation.

If DerivedFromOperationCalls is set, then this value is passed to the derivation lambda as a template that it can use as a base value to build on top of.

public object Request { get; set; }

Property Value

object

SkipPolling

If true, polling is skipped for this input even if the operation has polling configured.

public bool SkipPolling { get; set; }

Property Value

bool

Methods

Clone()

Performs a selective deep clone of this object.

public OperationInput Clone()

Returns

OperationInput

ConstructDerivedOperationName(string, string, string)

public static string ConstructDerivedOperationName(string sourceOperationCallName, string derivedOperationName, string derivationVariant)

Parameters

sourceOperationCallName string

derivedOperationName string

derivationVariant string

Returns

string

WithPolling(PollingSetup)

Sets the polling setup for this input and returns the input for fluent chaining. This overrides the operation's default polling setup.

public OperationInput WithPolling(PollingSetup polling)

Parameters

polling PollingSetup

The polling setup to use for this input.

Returns

OperationInput

This input for fluent chaining.

WithoutPolling()

Disables polling for this input, even if the operation has polling configured.

public OperationInput WithoutPolling()

Returns

OperationInput

This input for fluent chaining.