remote_read.md

remote_read

Index

• fn withChunkedReadLimit(value)
• fn withFilterExternalLabels(value=true)
• fn withHTTPClientConfig(value)
• fn withHTTPClientConfigMixin(value)
• fn withHeaders(value)
• fn withHeadersMixin(value)
• fn withName(value)
• fn withReadRecent(value=true)
• fn withRemoteTimeout(value)
• fn withRequiredMatchers(value)
• fn withRequiredMatchersMixin(value)
• fn withUrl(value)
• fn withUrlMixin(value)
• obj HTTPClientConfig
  • fn withAuthorization(value)
  • fn withAuthorizationMixin(value)
  • fn withBasicAuth(value)
  • fn withBasicAuthMixin(value)
  • fn withBearerToken(value)
  • fn withBearerTokenFile(value)
  • fn withEnableHttp2(value=true)
  • fn withFollowRedirects(value=true)
  • fn withHttpHeaders(value)
  • fn withHttpHeadersMixin(value)
  • fn withNoProxy(value)
  • fn withOauth2(value)
  • fn withOauth2Mixin(value)
  • fn withProxyConnectHeader(value)
  • fn withProxyConnectHeaderMixin(value)
  • fn withProxyFromEnvironment(value=true)
  • fn withProxyUrl(value)
  • fn withProxyUrlMixin(value)
  • fn withTlsConfig(value)
  • fn withTlsConfigMixin(value)
  • obj authorization
    • fn withCredentials(value)
    • fn withCredentialsFile(value)
    • fn withCredentialsRef(value)
    • fn withType(value)
  • obj basic_auth
    • fn withPassword(value)
    • fn withPasswordFile(value)
    • fn withPasswordRef(value)
    • fn withUsername(value)
    • fn withUsernameFile(value)
    • fn withUsernameRef(value)
  • obj http_headers
    • fn withHeaders(value)
    • fn withHeadersMixin(value)
  • obj oauth2
    • fn withClientId(value)
    • fn withClientSecret(value)
    • fn withClientSecretFile(value)
    • fn withClientSecretRef(value)
    • fn withEndpointParams(value)
    • fn withEndpointParamsMixin(value)
    • fn withNoProxy(value)
    • fn withProxyConnectHeader(value)
    • fn withProxyConnectHeaderMixin(value)
    • fn withProxyFromEnvironment(value=true)
    • fn withProxyUrl(value)
    • fn withProxyUrlMixin(value)
    • fn withScopes(value)
    • fn withScopesMixin(value)
    • fn withTlsConfig(value)
    • fn withTlsConfigMixin(value)
    • fn withTokenUrl(value)
    • obj proxy_url
      • fn withForceQuery(value=true)
      • fn withFragment(value)
      • fn withHost(value)
      • fn withOmitHost(value=true)
      • fn withOpaque(value)
      • fn withPath(value)
      • fn withRawFragment(value)
      • fn withRawPath(value)
      • fn withRawQuery(value)
      • fn withScheme(value)
      • fn withUser(value)
      • fn withUserMixin(value)
    • obj tls_config
      • fn withCa(value)
      • fn withCaFile(value)
      • fn withCaRef(value)
      • fn withCert(value)
      • fn withCertFile(value)
      • fn withCertRef(value)
      • fn withInsecureSkipVerify(value=true)
      • fn withKey(value)
      • fn withKeyFile(value)
      • fn withKeyRef(value)
      • fn withMaxVersion(value)
      • fn withMinVersion(value)
      • fn withServerName(value)
  • obj proxy_url
    • fn withForceQuery(value=true)
    • fn withFragment(value)
    • fn withHost(value)
    • fn withOmitHost(value=true)
    • fn withOpaque(value)
    • fn withPath(value)
    • fn withRawFragment(value)
    • fn withRawPath(value)
    • fn withRawQuery(value)
    • fn withScheme(value)
    • fn withUser(value)
    • fn withUserMixin(value)
  • obj tls_config
    • fn withCa(value)
    • fn withCaFile(value)
    • fn withCaRef(value)
    • fn withCert(value)
    • fn withCertFile(value)
    • fn withCertRef(value)
    • fn withInsecureSkipVerify(value=true)
    • fn withKey(value)
    • fn withKeyFile(value)
    • fn withKeyRef(value)
    • fn withMaxVersion(value)
    • fn withMinVersion(value)
    • fn withServerName(value)
• obj url
  • fn withForceQuery(value=true)
  • fn withFragment(value)
  • fn withHost(value)
  • fn withOmitHost(value=true)
  • fn withOpaque(value)
  • fn withPath(value)
  • fn withRawFragment(value)
  • fn withRawPath(value)
  • fn withRawQuery(value)
  • fn withScheme(value)
  • fn withUser(value)
  • fn withUserMixin(value)

Fields

fn withChunkedReadLimit

withChunkedReadLimit(value)

PARAMETERS:

• value (integer)

fn withFilterExternalLabels

withFilterExternalLabels(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

Whether to use the external labels as selectors for the remote read endpoint.

fn withHTTPClientConfig

withHTTPClientConfig(value)

PARAMETERS:

• value (object)

HTTPClientConfig configures an HTTP client.

fn withHTTPClientConfigMixin

withHTTPClientConfigMixin(value)

PARAMETERS:

• value (object)

HTTPClientConfig configures an HTTP client.

fn withHeaders

withHeaders(value)

PARAMETERS:

• value (object)

fn withHeadersMixin

withHeadersMixin(value)

PARAMETERS:

• value (object)

fn withName

withName(value)

PARAMETERS:

• value (string)

fn withReadRecent

withReadRecent(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn withRemoteTimeout

withRemoteTimeout(value)

PARAMETERS:

• value (integer)

fn withRequiredMatchers

withRequiredMatchers(value)

PARAMETERS:

• value (object)

A LabelSet is a collection of LabelName and LabelValue pairs.

fn withRequiredMatchersMixin

withRequiredMatchersMixin(value)

PARAMETERS:

• value (object)

A LabelSet is a collection of LabelName and LabelValue pairs.

fn withUrl

withUrl(value)

PARAMETERS:

• value (object)

URL is a custom URL type that allows validation at configuration load time.

fn withUrlMixin

withUrlMixin(value)

PARAMETERS:

• value (object)

URL is a custom URL type that allows validation at configuration load time.

obj HTTPClientConfig

fn HTTPClientConfig.withAuthorization

HTTPClientConfig.withAuthorization(value)

PARAMETERS:

• value (object)

The HTTP authorization credentials for the targets.

fn HTTPClientConfig.withAuthorizationMixin

HTTPClientConfig.withAuthorizationMixin(value)

PARAMETERS:

• value (object)

The HTTP authorization credentials for the targets.

fn HTTPClientConfig.withBasicAuth

HTTPClientConfig.withBasicAuth(value)

PARAMETERS:

• value (object)

BasicAuth contains basic HTTP authentication credentials.

fn HTTPClientConfig.withBasicAuthMixin

HTTPClientConfig.withBasicAuthMixin(value)

PARAMETERS:

• value (object)

BasicAuth contains basic HTTP authentication credentials.

fn HTTPClientConfig.withBearerToken

HTTPClientConfig.withBearerToken(value)

PARAMETERS:

• value (string)

The bearer token for the targets. Deprecated in favour of Authorization.Credentials.

fn HTTPClientConfig.withBearerTokenFile

HTTPClientConfig.withBearerTokenFile(value)

PARAMETERS:

• value (string)

The bearer token file for the targets. Deprecated in favour of Authorization.CredentialsFile.

fn HTTPClientConfig.withEnableHttp2

HTTPClientConfig.withEnableHttp2(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

EnableHTTP2 specifies whether the client should configure HTTP2. The omitempty flag is not set, because it would be hidden from the marshalled configuration when set to false.

fn HTTPClientConfig.withFollowRedirects

HTTPClientConfig.withFollowRedirects(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

FollowRedirects specifies whether the client should follow HTTP 3xx redirects. The omitempty flag is not set, because it would be hidden from the marshalled configuration when set to false.

fn HTTPClientConfig.withHttpHeaders

HTTPClientConfig.withHttpHeaders(value)

PARAMETERS:

• value (object)

Headers represents the configuration for HTTP headers.

fn HTTPClientConfig.withHttpHeadersMixin

HTTPClientConfig.withHttpHeadersMixin(value)

PARAMETERS:

• value (object)

Headers represents the configuration for HTTP headers.

fn HTTPClientConfig.withNoProxy

HTTPClientConfig.withNoProxy(value)

PARAMETERS:

• value (string)

NoProxy contains addresses that should not use a proxy.

fn HTTPClientConfig.withOauth2

HTTPClientConfig.withOauth2(value)

PARAMETERS:

• value (object)

OAuth2 is the oauth2 client configuration.

fn HTTPClientConfig.withOauth2Mixin

HTTPClientConfig.withOauth2Mixin(value)

PARAMETERS:

• value (object)

OAuth2 is the oauth2 client configuration.

fn HTTPClientConfig.withProxyConnectHeader

HTTPClientConfig.withProxyConnectHeader(value)

PARAMETERS:

• value (object)

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. Assume that at least some of these headers are going to contain secrets and use Secret as the value type instead of string.

fn HTTPClientConfig.withProxyConnectHeaderMixin

HTTPClientConfig.withProxyConnectHeaderMixin(value)

PARAMETERS:

• value (object)

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. Assume that at least some of these headers are going to contain secrets and use Secret as the value type instead of string.

fn HTTPClientConfig.withProxyFromEnvironment

HTTPClientConfig.withProxyFromEnvironment(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

ProxyFromEnvironment makes use of net/http ProxyFromEnvironment function to determine proxies.

fn HTTPClientConfig.withProxyUrl

HTTPClientConfig.withProxyUrl(value)

PARAMETERS:

• value (object)

URL is a custom URL type that allows validation at configuration load time.

fn HTTPClientConfig.withProxyUrlMixin

HTTPClientConfig.withProxyUrlMixin(value)

PARAMETERS:

• value (object)

URL is a custom URL type that allows validation at configuration load time.

fn HTTPClientConfig.withTlsConfig

HTTPClientConfig.withTlsConfig(value)

PARAMETERS:

• value (object)

TLSConfig configures the options for TLS connections.

fn HTTPClientConfig.withTlsConfigMixin

HTTPClientConfig.withTlsConfigMixin(value)

PARAMETERS:

• value (object)

TLSConfig configures the options for TLS connections.

obj HTTPClientConfig.authorization

fn HTTPClientConfig.authorization.withCredentials

HTTPClientConfig.authorization.withCredentials(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.authorization.withCredentialsFile

HTTPClientConfig.authorization.withCredentialsFile(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.authorization.withCredentialsRef

HTTPClientConfig.authorization.withCredentialsRef(value)

PARAMETERS:

• value (string)

CredentialsRef is the name of the secret within the secret manager to use as credentials.

fn HTTPClientConfig.authorization.withType

HTTPClientConfig.authorization.withType(value)

PARAMETERS:

• value (string)

obj HTTPClientConfig.basic_auth

fn HTTPClientConfig.basic_auth.withPassword

HTTPClientConfig.basic_auth.withPassword(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.basic_auth.withPasswordFile

HTTPClientConfig.basic_auth.withPasswordFile(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.basic_auth.withPasswordRef

HTTPClientConfig.basic_auth.withPasswordRef(value)

PARAMETERS:

• value (string)

PasswordRef is the name of the secret within the secret manager to use as the password.

fn HTTPClientConfig.basic_auth.withUsername

HTTPClientConfig.basic_auth.withUsername(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.basic_auth.withUsernameFile

HTTPClientConfig.basic_auth.withUsernameFile(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.basic_auth.withUsernameRef

HTTPClientConfig.basic_auth.withUsernameRef(value)

PARAMETERS:

• value (string)

UsernameRef is the name of the secret within the secret manager to use as the username.

obj HTTPClientConfig.http_headers

fn HTTPClientConfig.http_headers.withHeaders

HTTPClientConfig.http_headers.withHeaders(value)

PARAMETERS:

• value (object)

fn HTTPClientConfig.http_headers.withHeadersMixin

HTTPClientConfig.http_headers.withHeadersMixin(value)

PARAMETERS:

• value (object)

obj HTTPClientConfig.oauth2

fn HTTPClientConfig.oauth2.withClientId

HTTPClientConfig.oauth2.withClientId(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.oauth2.withClientSecret

HTTPClientConfig.oauth2.withClientSecret(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.oauth2.withClientSecretFile

HTTPClientConfig.oauth2.withClientSecretFile(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.oauth2.withClientSecretRef

HTTPClientConfig.oauth2.withClientSecretRef(value)

PARAMETERS:

• value (string)

ClientSecretRef is the name of the secret within the secret manager to use as the client secret.

fn HTTPClientConfig.oauth2.withEndpointParams

HTTPClientConfig.oauth2.withEndpointParams(value)

PARAMETERS:

• value (object)

fn HTTPClientConfig.oauth2.withEndpointParamsMixin

HTTPClientConfig.oauth2.withEndpointParamsMixin(value)

PARAMETERS:

• value (object)

fn HTTPClientConfig.oauth2.withNoProxy

HTTPClientConfig.oauth2.withNoProxy(value)

PARAMETERS:

• value (string)

NoProxy contains addresses that should not use a proxy.

fn HTTPClientConfig.oauth2.withProxyConnectHeader

HTTPClientConfig.oauth2.withProxyConnectHeader(value)

PARAMETERS:

• value (object)

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. Assume that at least some of these headers are going to contain secrets and use Secret as the value type instead of string.

fn HTTPClientConfig.oauth2.withProxyConnectHeaderMixin

HTTPClientConfig.oauth2.withProxyConnectHeaderMixin(value)

PARAMETERS:

• value (object)

ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. Assume that at least some of these headers are going to contain secrets and use Secret as the value type instead of string.

fn HTTPClientConfig.oauth2.withProxyFromEnvironment

HTTPClientConfig.oauth2.withProxyFromEnvironment(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

ProxyFromEnvironment makes use of net/http ProxyFromEnvironment function to determine proxies.

fn HTTPClientConfig.oauth2.withProxyUrl

HTTPClientConfig.oauth2.withProxyUrl(value)

PARAMETERS:

• value (object)

URL is a custom URL type that allows validation at configuration load time.

fn HTTPClientConfig.oauth2.withProxyUrlMixin

HTTPClientConfig.oauth2.withProxyUrlMixin(value)

PARAMETERS:

• value (object)

URL is a custom URL type that allows validation at configuration load time.

fn HTTPClientConfig.oauth2.withScopes

HTTPClientConfig.oauth2.withScopes(value)

PARAMETERS:

• value (array)

fn HTTPClientConfig.oauth2.withScopesMixin

HTTPClientConfig.oauth2.withScopesMixin(value)

PARAMETERS:

• value (array)

fn HTTPClientConfig.oauth2.withTlsConfig

HTTPClientConfig.oauth2.withTlsConfig(value)

PARAMETERS:

• value (object)

TLSConfig configures the options for TLS connections.

fn HTTPClientConfig.oauth2.withTlsConfigMixin

HTTPClientConfig.oauth2.withTlsConfigMixin(value)

PARAMETERS:

• value (object)

TLSConfig configures the options for TLS connections.

fn HTTPClientConfig.oauth2.withTokenUrl

HTTPClientConfig.oauth2.withTokenUrl(value)

PARAMETERS:

• value (string)

obj HTTPClientConfig.oauth2.proxy_url

fn HTTPClientConfig.oauth2.proxy_url.withForceQuery

HTTPClientConfig.oauth2.proxy_url.withForceQuery(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn HTTPClientConfig.oauth2.proxy_url.withFragment

HTTPClientConfig.oauth2.proxy_url.withFragment(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.oauth2.proxy_url.withHost

HTTPClientConfig.oauth2.proxy_url.withHost(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.oauth2.proxy_url.withOmitHost

HTTPClientConfig.oauth2.proxy_url.withOmitHost(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn HTTPClientConfig.oauth2.proxy_url.withOpaque

HTTPClientConfig.oauth2.proxy_url.withOpaque(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.oauth2.proxy_url.withPath

HTTPClientConfig.oauth2.proxy_url.withPath(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.oauth2.proxy_url.withRawFragment

HTTPClientConfig.oauth2.proxy_url.withRawFragment(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.oauth2.proxy_url.withRawPath

HTTPClientConfig.oauth2.proxy_url.withRawPath(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.oauth2.proxy_url.withRawQuery

HTTPClientConfig.oauth2.proxy_url.withRawQuery(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.oauth2.proxy_url.withScheme

HTTPClientConfig.oauth2.proxy_url.withScheme(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.oauth2.proxy_url.withUser

HTTPClientConfig.oauth2.proxy_url.withUser(value)

PARAMETERS:

• value (object)

fn HTTPClientConfig.oauth2.proxy_url.withUserMixin

HTTPClientConfig.oauth2.proxy_url.withUserMixin(value)

PARAMETERS:

• value (object)

obj HTTPClientConfig.oauth2.tls_config

fn HTTPClientConfig.oauth2.tls_config.withCa

HTTPClientConfig.oauth2.tls_config.withCa(value)

PARAMETERS:

• value (string)

Text of the CA cert to use for the targets.

fn HTTPClientConfig.oauth2.tls_config.withCaFile

HTTPClientConfig.oauth2.tls_config.withCaFile(value)

PARAMETERS:

• value (string)

The CA cert to use for the targets.

fn HTTPClientConfig.oauth2.tls_config.withCaRef

HTTPClientConfig.oauth2.tls_config.withCaRef(value)

PARAMETERS:

• value (string)

CARef is the name of the secret within the secret manager to use as the CA cert for the targets.

fn HTTPClientConfig.oauth2.tls_config.withCert

HTTPClientConfig.oauth2.tls_config.withCert(value)

PARAMETERS:

• value (string)

Text of the client cert file for the targets.

fn HTTPClientConfig.oauth2.tls_config.withCertFile

HTTPClientConfig.oauth2.tls_config.withCertFile(value)

PARAMETERS:

• value (string)

The client cert file for the targets.

fn HTTPClientConfig.oauth2.tls_config.withCertRef

HTTPClientConfig.oauth2.tls_config.withCertRef(value)

PARAMETERS:

• value (string)

CertRef is the name of the secret within the secret manager to use as the client cert for the targets.

fn HTTPClientConfig.oauth2.tls_config.withInsecureSkipVerify

HTTPClientConfig.oauth2.tls_config.withInsecureSkipVerify(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

Disable target certificate validation.

fn HTTPClientConfig.oauth2.tls_config.withKey

HTTPClientConfig.oauth2.tls_config.withKey(value)

PARAMETERS:

• value (string)

Text of the client key file for the targets.

fn HTTPClientConfig.oauth2.tls_config.withKeyFile

HTTPClientConfig.oauth2.tls_config.withKeyFile(value)

PARAMETERS:

• value (string)

The client key file for the targets.

fn HTTPClientConfig.oauth2.tls_config.withKeyRef

HTTPClientConfig.oauth2.tls_config.withKeyRef(value)

PARAMETERS:

• value (string)

KeyRef is the name of the secret within the secret manager to use as the client key for the targets.

fn HTTPClientConfig.oauth2.tls_config.withMaxVersion

HTTPClientConfig.oauth2.tls_config.withMaxVersion(value)

PARAMETERS:

• value (integer)

Maximum TLS version.

fn HTTPClientConfig.oauth2.tls_config.withMinVersion

HTTPClientConfig.oauth2.tls_config.withMinVersion(value)

PARAMETERS:

• value (integer)

Minimum TLS version.

fn HTTPClientConfig.oauth2.tls_config.withServerName

HTTPClientConfig.oauth2.tls_config.withServerName(value)

PARAMETERS:

• value (string)

Used to verify the hostname for the targets.

obj HTTPClientConfig.proxy_url

fn HTTPClientConfig.proxy_url.withForceQuery

HTTPClientConfig.proxy_url.withForceQuery(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn HTTPClientConfig.proxy_url.withFragment

HTTPClientConfig.proxy_url.withFragment(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.proxy_url.withHost

HTTPClientConfig.proxy_url.withHost(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.proxy_url.withOmitHost

HTTPClientConfig.proxy_url.withOmitHost(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn HTTPClientConfig.proxy_url.withOpaque

HTTPClientConfig.proxy_url.withOpaque(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.proxy_url.withPath

HTTPClientConfig.proxy_url.withPath(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.proxy_url.withRawFragment

HTTPClientConfig.proxy_url.withRawFragment(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.proxy_url.withRawPath

HTTPClientConfig.proxy_url.withRawPath(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.proxy_url.withRawQuery

HTTPClientConfig.proxy_url.withRawQuery(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.proxy_url.withScheme

HTTPClientConfig.proxy_url.withScheme(value)

PARAMETERS:

• value (string)

fn HTTPClientConfig.proxy_url.withUser

HTTPClientConfig.proxy_url.withUser(value)

PARAMETERS:

• value (object)

fn HTTPClientConfig.proxy_url.withUserMixin

HTTPClientConfig.proxy_url.withUserMixin(value)

PARAMETERS:

• value (object)

obj HTTPClientConfig.tls_config

fn HTTPClientConfig.tls_config.withCa

HTTPClientConfig.tls_config.withCa(value)

PARAMETERS:

• value (string)

Text of the CA cert to use for the targets.

fn HTTPClientConfig.tls_config.withCaFile

HTTPClientConfig.tls_config.withCaFile(value)

PARAMETERS:

• value (string)

The CA cert to use for the targets.

fn HTTPClientConfig.tls_config.withCaRef

HTTPClientConfig.tls_config.withCaRef(value)

PARAMETERS:

• value (string)

CARef is the name of the secret within the secret manager to use as the CA cert for the targets.

fn HTTPClientConfig.tls_config.withCert

HTTPClientConfig.tls_config.withCert(value)

PARAMETERS:

• value (string)

Text of the client cert file for the targets.

fn HTTPClientConfig.tls_config.withCertFile

HTTPClientConfig.tls_config.withCertFile(value)

PARAMETERS:

• value (string)

The client cert file for the targets.

fn HTTPClientConfig.tls_config.withCertRef

HTTPClientConfig.tls_config.withCertRef(value)

PARAMETERS:

• value (string)

CertRef is the name of the secret within the secret manager to use as the client cert for the targets.

fn HTTPClientConfig.tls_config.withInsecureSkipVerify

HTTPClientConfig.tls_config.withInsecureSkipVerify(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

Disable target certificate validation.

fn HTTPClientConfig.tls_config.withKey

HTTPClientConfig.tls_config.withKey(value)

PARAMETERS:

• value (string)

Text of the client key file for the targets.

fn HTTPClientConfig.tls_config.withKeyFile

HTTPClientConfig.tls_config.withKeyFile(value)

PARAMETERS:

• value (string)

The client key file for the targets.

fn HTTPClientConfig.tls_config.withKeyRef

HTTPClientConfig.tls_config.withKeyRef(value)

PARAMETERS:

• value (string)

KeyRef is the name of the secret within the secret manager to use as the client key for the targets.

fn HTTPClientConfig.tls_config.withMaxVersion

HTTPClientConfig.tls_config.withMaxVersion(value)

PARAMETERS:

• value (integer)

Maximum TLS version.

fn HTTPClientConfig.tls_config.withMinVersion

HTTPClientConfig.tls_config.withMinVersion(value)

PARAMETERS:

• value (integer)

Minimum TLS version.

fn HTTPClientConfig.tls_config.withServerName

HTTPClientConfig.tls_config.withServerName(value)

PARAMETERS:

• value (string)

Used to verify the hostname for the targets.

obj url

fn url.withForceQuery

url.withForceQuery(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn url.withFragment

url.withFragment(value)

PARAMETERS:

• value (string)

fn url.withHost

url.withHost(value)

PARAMETERS:

• value (string)

fn url.withOmitHost

url.withOmitHost(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn url.withOpaque

url.withOpaque(value)

PARAMETERS:

• value (string)

fn url.withPath

url.withPath(value)

PARAMETERS:

• value (string)

fn url.withRawFragment

url.withRawFragment(value)

PARAMETERS:

• value (string)

fn url.withRawPath

url.withRawPath(value)

PARAMETERS:

• value (string)

fn url.withRawQuery

url.withRawQuery(value)

PARAMETERS:

• value (string)

fn url.withScheme

url.withScheme(value)

PARAMETERS:

• value (string)

fn url.withUser

url.withUser(value)

PARAMETERS:

• value (object)

fn url.withUserMixin

url.withUserMixin(value)

PARAMETERS:

• value (object)