Table of Contents

Class CurlRequest

Namespace
ArcanaDevelopment.adTempus.Shared.WebRequests
Assembly
ArcanaDevelopment.adTempus.Shared.dll

A web request definition exchanged with curl command lines.

public sealed class CurlRequest
Inheritance
object
CurlRequest

Remarks

Produced by ArcanaDevelopment.adTempus.Shared.WebRequests.CurlCommandParser and consumed by ArcanaDevelopment.adTempus.Shared.WebRequests.CurlCommandBuilder. Properties that are null were not specified and should leave the corresponding task setting unchanged.

Properties

AuthenticationType

The authentication type, if one was specified.

public WebRequestAuthenticationType? AuthenticationType { get; set; }

Property Value

WebRequestAuthenticationType?

Body

The body for Raw.

[CanBeNull]
public string Body { get; set; }

Property Value

string

BodyType

How the request body is constructed.

public WebRequestBodyType BodyType { get; set; }

Property Value

WebRequestBodyType

ContentType

The content type of a Raw body.

[CanBeNull]
public string ContentType { get; set; }

Property Value

string

FollowRedirects

Indicates whether redirects are followed, if specified.

public bool? FollowRedirects { get; set; }

Property Value

bool?

Headers

The request headers.

[NotNull]
public WebRequestHeaderList Headers { get; }

Property Value

WebRequestHeaderList

Remarks

Does not include Content-Type (see ContentType) or an Authorization header that was converted to an authentication setting.

IgnoreCertificateErrors

Indicates whether certificate errors are ignored.

public bool IgnoreCertificateErrors { get; set; }

Property Value

bool

MaxTimeSeconds

The maximum run time in seconds, if specified.

public int? MaxTimeSeconds { get; set; }

Property Value

int?

Method

The HTTP method.

[NotNull]
public string Method { get; set; }

Property Value

string

Parameters

The query string and body parameters.

[NotNull]
public WebRequestParameterList Parameters { get; }

Property Value

WebRequestParameterList

Password

The password, bearer token, or client secret.

[CanBeNull]
public string Password { get; set; }

Property Value

string

Remarks

null if not specified. When building a command, a null password is shown as a placeholder.

PasswordPromptRequired

Indicates that a user ID was specified without a password, so the user must be asked for it.

public bool PasswordPromptRequired { get; set; }

Property Value

bool

RetryCount

The number of retries, if specified.

public int? RetryCount { get; set; }

Property Value

int?

RetryDelaySeconds

The delay between retries in seconds, if specified.

public int? RetryDelaySeconds { get; set; }

Property Value

int?

SaveToLocation

The file the response is saved to, if specified.

[CanBeNull]
public string SaveToLocation { get; set; }

Property Value

string

Url

The request URL, without the query string.

[CanBeNull]
public string Url { get; set; }

Property Value

string

UserID

The user ID (or OAuth client ID).

[CanBeNull]
public string UserID { get; set; }

Property Value

string

Warnings

Messages about curl options that could not be converted.

[NotNull]
public List<string> Warnings { get; }

Property Value

List<string>