Class RemoteReadSpec

    • Method Detail

      • getAuthorization

        public Authorization getAuthorization()
        RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.
      • setAuthorization

        public void setAuthorization​(Authorization authorization)
        RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.
      • getBasicAuth

        public BasicAuth getBasicAuth()
        RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.
      • setBasicAuth

        public void setBasicAuth​(BasicAuth basicAuth)
        RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.
      • getBearerToken

        public String getBearerToken()
        bearerToken is deprecated: this will be removed in a future release. *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.*
      • setBearerToken

        public void setBearerToken​(String bearerToken)
        bearerToken is deprecated: this will be removed in a future release. *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.*
      • getBearerTokenFile

        public String getBearerTokenFile()
        bearerTokenFile defines the file from which to read the bearer token for the URL.


        Deprecated: this will be removed in a future release. Prefer using `authorization`.

      • setBearerTokenFile

        public void setBearerTokenFile​(String bearerTokenFile)
        bearerTokenFile defines the file from which to read the bearer token for the URL.


        Deprecated: this will be removed in a future release. Prefer using `authorization`.

      • getFilterExternalLabels

        public Boolean getFilterExternalLabels()
        filterExternalLabels defines whether to use the external labels as selectors for the remote read endpoint.


        It requires Prometheus >= v2.34.0.

      • setFilterExternalLabels

        public void setFilterExternalLabels​(Boolean filterExternalLabels)
        filterExternalLabels defines whether to use the external labels as selectors for the remote read endpoint.


        It requires Prometheus >= v2.34.0.

      • getFollowRedirects

        public Boolean getFollowRedirects()
        followRedirects defines whether HTTP requests follow HTTP 3xx redirects.


        It requires Prometheus >= v2.26.0.

      • setFollowRedirects

        public void setFollowRedirects​(Boolean followRedirects)
        followRedirects defines whether HTTP requests follow HTTP 3xx redirects.


        It requires Prometheus >= v2.26.0.

      • getHeaders

        public Map<String,​String> getHeaders()
        headers defines the custom HTTP headers to be sent along with each remote read request. Be aware that headers that are set by Prometheus itself can't be overwritten. Only valid in Prometheus versions 2.26.0 and newer.
      • setHeaders

        public void setHeaders​(Map<String,​String> headers)
        headers defines the custom HTTP headers to be sent along with each remote read request. Be aware that headers that are set by Prometheus itself can't be overwritten. Only valid in Prometheus versions 2.26.0 and newer.
      • getName

        public String getName()
        name of the remote read queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate read configurations.


        It requires Prometheus >= v2.15.0.

      • setName

        public void setName​(String name)
        name of the remote read queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate read configurations.


        It requires Prometheus >= v2.15.0.

      • getNoProxy

        public String getNoProxy()
        noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers.


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • setNoProxy

        public void setNoProxy​(String noProxy)
        noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers.


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • getOauth2

        public OAuth2 getOauth2()
        RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.
      • setOauth2

        public void setOauth2​(OAuth2 oauth2)
        RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.
      • getProxyConnectHeader

        public Map<String,​List<SecretKeySelector>> getProxyConnectHeader()
        proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • setProxyConnectHeader

        public void setProxyConnectHeader​(Map<String,​List<SecretKeySelector>> proxyConnectHeader)
        proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • getProxyFromEnvironment

        public Boolean getProxyFromEnvironment()
        proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • setProxyFromEnvironment

        public void setProxyFromEnvironment​(Boolean proxyFromEnvironment)
        proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • getProxyUrl

        public String getProxyUrl()
        proxyUrl defines the HTTP proxy server to use.
      • setProxyUrl

        public void setProxyUrl​(String proxyUrl)
        proxyUrl defines the HTTP proxy server to use.
      • getReadRecent

        public Boolean getReadRecent()
        readRecent defines whether reads should be made for queries for time ranges that the local storage should have complete data for.
      • setReadRecent

        public void setReadRecent​(Boolean readRecent)
        readRecent defines whether reads should be made for queries for time ranges that the local storage should have complete data for.
      • getRemoteTimeout

        public String getRemoteTimeout()
        remoteTimeout defines the timeout for requests to the remote read endpoint.
      • setRemoteTimeout

        public void setRemoteTimeout​(String remoteTimeout)
        remoteTimeout defines the timeout for requests to the remote read endpoint.
      • getRequiredMatchers

        public Map<String,​String> getRequiredMatchers()
        requiredMatchers defines an optional list of equality matchers which have to be present in a selector to query the remote read endpoint.
      • setRequiredMatchers

        public void setRequiredMatchers​(Map<String,​String> requiredMatchers)
        requiredMatchers defines an optional list of equality matchers which have to be present in a selector to query the remote read endpoint.
      • getTlsConfig

        public TLSConfig getTlsConfig()
        RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.
      • setTlsConfig

        public void setTlsConfig​(TLSConfig tlsConfig)
        RemoteReadSpec defines the configuration for Prometheus to read back samples from a remote endpoint.
      • getUrl

        public String getUrl()
        url defines the URL of the endpoint to query from.
      • setUrl

        public void setUrl​(String url)
        url defines the URL of the endpoint to query from.
      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()
      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                          Object value)
      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)