LuciadCPillar 2023.1.02
luciad::HttpRequestOptions Class Referencefinal

Options to be sent with an HTTP request. More...

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

Classes

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

Public Member Functions

 HttpRequestOptions (const HttpRequestOptions &other)
 
 HttpRequestOptions (HttpRequestOptions &&other) noexcept
 
 ~HttpRequestOptions ()
 
Builder asBuilder () const
 Returns an HttpRequestOptions builder that has all properties of this HttpRequestOptions. More...
 
const std::vector< HttpHeader > & getHeaders () const
 
const std::vector< UriQueryParameter > & getQueryParameters () const
 
HttpRequestOptionsoperator= (HttpRequestOptions other) noexcept
 

Static Public Member Functions

static Builder newBuilder ()
 Creates a new HttpRequestOptions builder. More...
 

Detailed Description

Options to be sent with an HTTP request.

This is a collection of luciad::HttpHeaders and luciad::UriQueryParameters. An HttpRequestOptions instance is built through an luciad::HttpResponse::Builder.

Since
2023.0

Constructor & Destructor Documentation

◆ ~HttpRequestOptions()

luciad::HttpRequestOptions::~HttpRequestOptions ( )

◆ HttpRequestOptions() [1/2]

luciad::HttpRequestOptions::HttpRequestOptions ( const HttpRequestOptions other)

◆ HttpRequestOptions() [2/2]

luciad::HttpRequestOptions::HttpRequestOptions ( HttpRequestOptions &&  other)
noexcept

Member Function Documentation

◆ asBuilder()

Builder luciad::HttpRequestOptions::asBuilder ( ) const

Returns an HttpRequestOptions builder that has all properties of this HttpRequestOptions.

Returns
an HttpRequestOptions builder that has all properties of this HttpRequestOptions.

◆ getHeaders()

const std::vector< HttpHeader > & luciad::HttpRequestOptions::getHeaders ( ) const
Returns
the HTTP headers for this request options instance.

◆ getQueryParameters()

const std::vector< UriQueryParameter > & luciad::HttpRequestOptions::getQueryParameters ( ) const
Returns
the query parameters for this request options instance.

◆ newBuilder()

static Builder luciad::HttpRequestOptions::newBuilder ( )
static

Creates a new HttpRequestOptions builder.

Returns
a new HttpRequestOptions builder.

◆ operator=()

HttpRequestOptions & luciad::HttpRequestOptions::operator= ( HttpRequestOptions  other)
noexcept