luciad::HttpRequestOptions::Builder Class Reference

Builder for the luciad::HttpRequestOptions class. More...

#include <luciad/net/http/HttpRequestOptions.h>

Public Member Functions
	Builder (const Builder &other)
	~Builder ()
HttpRequestOptions	build () const
	Returns an luciad::HttpRequestOptions, based on the properties set on this builder. More...
Builder &	header (HttpHeader header)
	Sets the given http header to the set of headers for this options. More...
Builder &	header (std::string name, std::string value)
	Sets the given name value pair to the set of headers for this options. More...
Builder &	queryParameter (std::string name, std::string value)
	Sets the given name value pair to the set of query parameters for this options. More...
Builder &	queryParameter (UriQueryParameter queryParameter)
	Sets the given query parameter to the set of query parameters for this options. More...

Detailed Description

Builder for the luciad::HttpRequestOptions class.

Instances of HttpRequestOptions::Builder are created by calling luciad::HttpRequestOptions::newBuilder.

Since

2023.0

Constructor & Destructor Documentation

~Builder()

luciad::HttpRequestOptions::Builder::~Builder

(

)

Builder()

luciad::HttpRequestOptions::Builder::Builder

(

const Builder &

other

)

Member Function Documentation

build()

HttpRequestOptions luciad::HttpRequestOptions::Builder::build

(

)

const

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

Returns

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

header() [1/2]

Builder & luciad::HttpRequestOptions::Builder::header

(

HttpHeader

header

)

Sets the given http header to the set of headers for this options.

Parameters

header

an luciad::HttpHeader.

Returns

this builder.

header() [2/2]

Builder & luciad::HttpRequestOptions::Builder::header	(	std::string	name,
		std::string	value
	)

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

Parameters

name	header name
value	header value

Returns

this builder.

queryParameter() [1/2]

Builder & luciad::HttpRequestOptions::Builder::queryParameter	(	std::string	name,
		std::string	value
	)

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

Parameters

name	query parameter name.
value	query parameter value.

Returns

this builder.

queryParameter() [2/2]

Builder & luciad::HttpRequestOptions::Builder::queryParameter

(

UriQueryParameter

queryParameter

)

Sets the given query parameter to the set of query parameters for this options.

Parameters

queryParameter

an luciad::UriQueryParameter.

Returns

this builder.