singer_sdk.streams.rest.HTTPRequest

class singer_sdk.streams.rest.HTTPRequest

HTTP request for a stream.

Added in version NEXT_VERSION.

__init__(url, method, headers, params=<factory>, data=None, safe_query_chars='')

Parameters:

• url (str)

• method (str)

• headers (dict[str, str])

• params (dict[str, t.Any | list[t.Any] | None])

• data (JSONPayload)

• safe_query_chars (str)

Return type:

None

encode_params()

Encode parameters as a string.

Constructs a string of URL parameters for the request. Uses urllib.parse.urlencode() to encode the parameters.

Returns:

A string of encoded parameters.

Return type:

str

data: JSONPayload

The data of the request.

headers: dict[str, str]

The headers of the request.

method: str

The method of the request.

params: dict[str, t.Any | list[t.Any] | None]

The URL queryparameters of the request.

safe_query_chars: str

ASCII characters that should not be quoted when encoding URL parameters.

url: str

The URL of the request.