Luciad.Net.Http.HttpRequest.Builder Class Reference

A builder of luciad::HttpRequests. More...

Inheritance diagram for Luciad.Net.Http.HttpRequest.Builder:

Public Member Functions
	Builder (Luciad.Net.Http.HttpRequest.Builder other)
Luciad.Net.Http.HttpRequest.Builder	Body (Luciad.Containers.DataEntity body)
	Sets the HTTP request content. More...
Luciad.Net.Http.HttpRequest	Build ()
	Returns an luciad::HttpRequest, based on the properties set on this builder. More...
void	Dispose ()
Luciad.Net.Http.HttpRequest.Builder	Header (Luciad.Net.Http.HttpHeader header)
Luciad.Net.Http.HttpRequest.Builder	Header (string name, string value)
	Sets the given name value pair to the set of headers for this request. More...
Luciad.Net.Http.HttpRequest.Builder	Method (Luciad.Net.Http.HttpRequestMethod method)
	Sets the request method of this builder. More...
Luciad.Net.Http.HttpRequest.Builder	QueryParameter (Luciad.Net.UriQueryParameter queryParameter)
Luciad.Net.Http.HttpRequest.Builder	QueryParameter (string name, string value)
	Sets the given name value pair to the set of query parameters for this request. More...
Luciad.Net.Http.HttpRequest.Builder	Uri (string uri)
	Sets this HttpRequest's request URI. More...

Detailed Description

A builder of luciad::HttpRequests.

Instances of HttpRequest::Builder are created by calling luciad::HttpRequest::newBuilder. The builder can be used to configure the request URI, the request method (default is GET unless explicitly set), specific request headers, etc. The build method returns a new luciad::HttpRequest each time it is invoked. Once built an HttpRequest is immutable. 2023.0

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpRequest::Builder.

Constructor & Destructor Documentation

Builder()

Luciad.Net.Http.HttpRequest.Builder.Builder ( Luciad.Net.Http.HttpRequest.Builder  other )

inline

Member Function Documentation

Body()

Luciad.Net.Http.HttpRequest.Builder Luciad.Net.Http.HttpRequest.Builder.Body ( Luciad.Containers.DataEntity  body )

inline

Sets the HTTP request content.

This parameter is optional unless this HttpRequest's method has been set to POST or PUT. If not set when the request method is POST or PUT, HttpRequest::Builder::build will throw an exception.

body

the request content.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpRequest::Builder::body.

Build()

Luciad.Net.Http.HttpRequest Luciad.Net.Http.HttpRequest.Builder.Build ( )

inline

Returns an luciad::HttpRequest, based on the properties set on this builder.

an luciad::HttpRequest, based on the properties set on this builder.

luciad::LogicException

if a URI has not been set.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpRequest::Builder::build.

Dispose()

void Luciad.Net.Http.HttpRequest.Builder.Dispose ( )

inline

Header() [1/2]

Luciad.Net.Http.HttpRequest.Builder Luciad.Net.Http.HttpRequest.Builder.Header ( Luciad.Net.Http.HttpHeader  header )

inline

Header() [2/2]

Luciad.Net.Http.HttpRequest.Builder Luciad.Net.Http.HttpRequest.Builder.Header ( string  name, string  value  )

inline

Sets the given name value pair to the set of headers for this request.

name

header name

value

header value

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpRequest::Builder::header.

Method()

Luciad.Net.Http.HttpRequest.Builder Luciad.Net.Http.HttpRequest.Builder.Method ( Luciad.Net.Http.HttpRequestMethod  method )

inline

Sets the request method of this builder.

This parameter is optional. If not set, default is GET.

method

the method to use.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpRequest::Builder::method.

QueryParameter() [1/2]

Luciad.Net.Http.HttpRequest.Builder Luciad.Net.Http.HttpRequest.Builder.QueryParameter ( Luciad.Net.UriQueryParameter  queryParameter )

inline

QueryParameter() [2/2]

Luciad.Net.Http.HttpRequest.Builder Luciad.Net.Http.HttpRequest.Builder.QueryParameter ( string  name, string  value  )

inline

Sets the given name value pair to the set of query parameters for this request.

name

query parameter name.

value

query parameter value.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpRequest::Builder::queryParameter.

Uri()

Luciad.Net.Http.HttpRequest.Builder Luciad.Net.Http.HttpRequest.Builder.Uri ( string  uri )

inline

Sets this HttpRequest's request URI.

The provided URI can have a query string. This parameter is mandatory. If it is not set, HttpRequest::Builder::build will throw an exception.

uri

request URI string.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::HttpRequest::Builder::uri.