runtime-core/aws.smithy.kotlin.runtime.net.url/Url/Builder

Builder

class Builder : CanDeepCopy<Url.Builder>

A mutable builder used to construct Url instances

Constructors

constructor()

Initialize an empty Url builder

Properties

decodedFragment

var decodedFragment: String?

Get or set the fragment as a decoded string

encodedFragment

var encodedFragment: String?

Get or set the fragment as an encoded string

The Host for the URL

val hostAndPort: String

Gets the host and port for the URL. The port is omitted if it's the default for the scheme.

val parameters: QueryParameters.Builder

Gets the query parameters builder

var path: UrlPath.Builder

Gets the URL path builder

var port: Int?

The remote port number for the URL (e.g., TCP port)

requestRelativePath

val requestRelativePath: String

Gets a request-relative path string for this URL which is suitable for use in an HTTP request line. The given path will include query parameters and the fragment and will be prepended with a / (even for empty paths without a trailing slash configured). It will not include the protocol, host, port, or user info.

var scheme: Scheme

The wire protocol (e.g., http, https, etc.)

val userInfo: UserInfo.Builder

Get the user info builder

Functions

fun build(): Url

Build a new Url from the currently-configured builder values

fun copyFrom(url: Url)

Copies state from url into this builder. All existing state is overwritten.

open override fun deepCopy(): Url.Builder

Returns a deep copy of this object.

inline fun parameters(block: QueryParameters.Builder.() -> Unit)

Update the QueryParameters of this URL via a DSL builder block

inline fun path(block: UrlPath.Builder.() -> Unit)

Update the UrlPath of this URL via a DSL builder block

inline fun userInfo(block: UserInfo.Builder.() -> Unit)

Set the user info in this URL via a DSL builder block