smithy-client/aws.smithy.kotlin.runtime.client.endpoints/Endpoint

Endpoint

data class Endpoint(val uri: <Error class: unknown class>, val headers: <Error class: unknown class><String>? = null, val attributes: <Error class: unknown class> = emptyAttributes())

Represents the endpoint a service client should make API operation calls to.

The SDK will automatically resolve these endpoints per API client using an internal resolver.

Constructors

Endpoint

constructor(uri: String)

constructor(uri: <Error class: unknown class>, headers: <Error class: unknown class><String>? = null)

constructor(uri: <Error class: unknown class>, headers: <Error class: unknown class><String>? = null, attributes: <Error class: unknown class> = emptyAttributes())

Properties

attributes

val attributes: <Error class: unknown class>

A grab-bag property map of endpoint attributes. The values here are only set when an endpoint is returned from evaluating a ruleset.

headers

val headers: <Error class: unknown class><String>? = null

A map of additional HTTP headers to be set when making calls against this endpoint.

uri

val uri: <Error class: unknown class>

The base URL endpoint clients will use to make API calls to e.g. "api.myservice.com". NOTE: Only scheme, port, host path, and parameters are valid. Other URL elements are ignored.

Inherited properties

authOptions

val Endpoint.authOptions: List<<Error class: unknown class>>

Sugar extension to pull the auth option(s) out of the endpoint attributes.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int