Skip to content

Latest commit

 

History

History
476 lines (325 loc) · 10.9 KB

index.md

File metadata and controls

476 lines (325 loc) · 10.9 KB
Raw

http

Subpackages

Index

Fields

fn new

new(validStatusCodes=[200])

PARAMETERS:

  • validStatusCodes (array)
    • default value: [200]

new provides the settings for a HTTP check.

fn withBasicAuth

withBasicAuth(value)

PARAMETERS:

  • value (array)

(Block Set, Max: 1) Basic auth settings. (see below for nested schema) Basic auth settings.

fn withBasicAuthMixin

withBasicAuthMixin(value)

PARAMETERS:

  • value (array)

(Block Set, Max: 1) Basic auth settings. (see below for nested schema) Basic auth settings.

fn withBearerTokenSecretRef

withBearerTokenSecretRef(value)

PARAMETERS:

  • value (object)

(String, Sensitive) Token for use with bearer authorization header. Token for use with bearer authorization header.

fn withBearerTokenSecretRefMixin

withBearerTokenSecretRefMixin(value)

PARAMETERS:

  • value (object)

(String, Sensitive) Token for use with bearer authorization header. Token for use with bearer authorization header.

fn withBody

withBody(value)

PARAMETERS:

  • value (string)

(String) The body of the HTTP request used in probe. The body of the HTTP request used in probe.

fn withCacheBustingQueryParamName

withCacheBustingQueryParamName(value)

PARAMETERS:

  • value (string)

(String) The name of the query parameter used to prevent the server from using a cached response. Each probe will assign a random value to this parameter each time a request is made. The name of the query parameter used to prevent the server from using a cached response. Each probe will assign a random value to this parameter each time a request is made.

fn withCompression

withCompression(value)

PARAMETERS:

  • value (string)

(String) Check fails if the response body is not compressed using this compression algorithm. One of none, identity, br, gzip, deflate. Check fails if the response body is not compressed using this compression algorithm. One of none, identity, br, gzip, deflate.

fn withFailIfBodyMatchesRegexp

withFailIfBodyMatchesRegexp(value)

PARAMETERS:

  • value (array)

(Set of String) List of regexes. If any match the response body, the check will fail. List of regexes. If any match the response body, the check will fail.

fn withFailIfBodyMatchesRegexpMixin

withFailIfBodyMatchesRegexpMixin(value)

PARAMETERS:

  • value (array)

(Set of String) List of regexes. If any match the response body, the check will fail. List of regexes. If any match the response body, the check will fail.

fn withFailIfBodyNotMatchesRegexp

withFailIfBodyNotMatchesRegexp(value)

PARAMETERS:

  • value (array)

(Set of String) List of regexes. If any do not match the response body, the check will fail. List of regexes. If any do not match the response body, the check will fail.

fn withFailIfBodyNotMatchesRegexpMixin

withFailIfBodyNotMatchesRegexpMixin(value)

PARAMETERS:

  • value (array)

(Set of String) List of regexes. If any do not match the response body, the check will fail. List of regexes. If any do not match the response body, the check will fail.

fn withFailIfHeaderMatchesRegexp

withFailIfHeaderMatchesRegexp(value)

PARAMETERS:

  • value (array)

(Block Set) Check fails if headers match. (see below for nested schema) Check fails if headers match.

fn withFailIfHeaderMatchesRegexpMixin

withFailIfHeaderMatchesRegexpMixin(value)

PARAMETERS:

  • value (array)

(Block Set) Check fails if headers match. (see below for nested schema) Check fails if headers match.

fn withFailIfHeaderNotMatchesRegexp

withFailIfHeaderNotMatchesRegexp(value)

PARAMETERS:

  • value (array)

(Block Set) Check fails if headers do not match. (see below for nested schema) Check fails if headers do not match.

fn withFailIfHeaderNotMatchesRegexpMixin

withFailIfHeaderNotMatchesRegexpMixin(value)

PARAMETERS:

  • value (array)

(Block Set) Check fails if headers do not match. (see below for nested schema) Check fails if headers do not match.

fn withFailIfNotSsl

withFailIfNotSsl(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

(Boolean) Fail if SSL is not present. Defaults to false. Fail if SSL is not present. Defaults to false.

fn withFailIfSsl

withFailIfSsl(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

(Boolean) Fail if SSL is present. Defaults to false. Fail if SSL is present. Defaults to false.

fn withHeaders

withHeaders(value)

PARAMETERS:

  • value (array)

(Set of String) The HTTP headers set for the probe. The HTTP headers set for the probe.

fn withHeadersMixin

withHeadersMixin(value)

PARAMETERS:

  • value (array)

(Set of String) The HTTP headers set for the probe. The HTTP headers set for the probe.

fn withIpVersion

withIpVersion(value)

PARAMETERS:

  • value (string)

(String) Options are V4, V6, Any. Specifies whether the corresponding check will be performed using IPv4 or IPv6. The Any value indicates that IPv6 should be used, falling back to IPv4 if that's not available. Defaults to V4. Options are V4, V6, Any. Specifies whether the corresponding check will be performed using IPv4 or IPv6. The Any value indicates that IPv6 should be used, falling back to IPv4 if that's not available. Defaults to V4.

fn withMethod

withMethod(value)

PARAMETERS:

  • value (string)

(String) Request method. One of GET, CONNECT, DELETE, HEAD, OPTIONS, POST, PUT, TRACE Defaults to GET. Request method. One of GET, CONNECT, DELETE, HEAD, OPTIONS, POST, PUT, TRACE Defaults to GET.

fn withNoFollowRedirects

withNoFollowRedirects(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

(Boolean) Do not follow redirects. Defaults to false. Do not follow redirects. Defaults to false.

fn withProxyConnectHeaders

withProxyConnectHeaders(value)

PARAMETERS:

  • value (array)

(Set of String) The HTTP headers sent to the proxy URL The HTTP headers sent to the proxy URL

fn withProxyConnectHeadersMixin

withProxyConnectHeadersMixin(value)

PARAMETERS:

  • value (array)

(Set of String) The HTTP headers sent to the proxy URL The HTTP headers sent to the proxy URL

fn withProxyUrl

withProxyUrl(value)

PARAMETERS:

  • value (string)

(String) Proxy URL. Proxy URL.

fn withTlsConfig

withTlsConfig(value)

PARAMETERS:

  • value (array)

(Block Set, Max: 1) TLS config. (see below for nested schema) TLS config.

fn withTlsConfigMixin

withTlsConfigMixin(value)

PARAMETERS:

  • value (array)

(Block Set, Max: 1) TLS config. (see below for nested schema) TLS config.

fn withValidHttpVersions

withValidHttpVersions(value)

PARAMETERS:

  • value (array)

(Set of String) List of valid HTTP versions. Options include HTTP/1.0, HTTP/1.1, HTTP/2.0 List of valid HTTP versions. Options include HTTP/1.0, HTTP/1.1, HTTP/2.0

fn withValidHttpVersionsMixin

withValidHttpVersionsMixin(value)

PARAMETERS:

  • value (array)

(Set of String) List of valid HTTP versions. Options include HTTP/1.0, HTTP/1.1, HTTP/2.0 List of valid HTTP versions. Options include HTTP/1.0, HTTP/1.1, HTTP/2.0

fn withValidStatusCodes

withValidStatusCodes(value)

PARAMETERS:

  • value (array)

(Set of Number) Accepted status codes. If unset, defaults to 2xx. Accepted status codes. If unset, defaults to 2xx.

fn withValidStatusCodesMixin

withValidStatusCodesMixin(value)

PARAMETERS:

  • value (array)

(Set of Number) Accepted status codes. If unset, defaults to 2xx. Accepted status codes. If unset, defaults to 2xx.

obj bearerTokenSecretRef

fn bearerTokenSecretRef.withKey

bearerTokenSecretRef.withKey(value)

PARAMETERS:

  • value (string)

The key to select.

fn bearerTokenSecretRef.withName

bearerTokenSecretRef.withName(value)

PARAMETERS:

  • value (string)

Name of the secret.

fn bearerTokenSecretRef.withNamespace

bearerTokenSecretRef.withNamespace(value)

PARAMETERS:

  • value (string)

Namespace of the secret.