java.lang.Object
- io.fabric8.openshift.api.model.monitoring.v1.ProbeSpec

All Implemented Interfaces:: io.fabric8.kubernetes.api.builder.Editable<ProbeSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class ProbeSpec
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ProbeSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

ProbeSpec contains specification parameters for a Probe.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor	Description
`ProbeSpec()`	No args constructor for use in serialization
ProbeSpec(SafeAuthorization authorization, BasicAuth basicAuth, io.fabric8.kubernetes.api.model.SecretKeySelector bearerTokenSecret, Boolean convertClassicHistogramsToNHCB, String fallbackScrapeProtocol, String interval, String jobName, Long keepDroppedTargets, Long labelLimit, Long labelNameLengthLimit, Long labelValueLengthLimit, List<RelabelConfig> metricRelabelings, String module, Long nativeHistogramBucketLimit, io.fabric8.kubernetes.api.model.Quantity nativeHistogramMinBucketFactor, OAuth2 oauth2, List<ProbeParam> params, ProberSpec prober, Long sampleLimit, String scrapeClass, Boolean scrapeClassicHistograms, List<String> scrapeProtocols, String scrapeTimeout, Long targetLimit, ProbeTargets targets, SafeTLSConfig tlsConfig)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ProbeSpecBuilder`	`edit()`
`Map<String,Object>`	`getAdditionalProperties()`
`SafeAuthorization`	`getAuthorization()`	ProbeSpec contains specification parameters for a Probe.
`BasicAuth`	`getBasicAuth()`	ProbeSpec contains specification parameters for a Probe.
`io.fabric8.kubernetes.api.model.SecretKeySelector`	`getBearerTokenSecret()`	ProbeSpec contains specification parameters for a Probe.
`Boolean`	`getConvertClassicHistogramsToNHCB()`	Whether to convert all scraped classic histograms into a native histogram with custom buckets.
`String`	`getFallbackScrapeProtocol()`	The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.
`String`	`getInterval()`	Interval at which targets are probed using the configured prober.
`String`	`getJobName()`	The job name assigned to scraped metrics by default.
`Long`	`getKeepDroppedTargets()`	Per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.
`Long`	`getLabelLimit()`	Per-scrape limit on number of labels that will be accepted for a sample.
`Long`	`getLabelNameLengthLimit()`	Per-scrape limit on length of labels name that will be accepted for a sample.
`Long`	`getLabelValueLengthLimit()`	Per-scrape limit on length of labels value that will be accepted for a sample.
`List<RelabelConfig>`	`getMetricRelabelings()`	MetricRelabelConfigs to apply to samples before ingestion.
`String`	`getModule()`	The module to use for probing specifying how to probe the target.
`Long`	`getNativeHistogramBucketLimit()`	If there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit.
`io.fabric8.kubernetes.api.model.Quantity`	`getNativeHistogramMinBucketFactor()`	ProbeSpec contains specification parameters for a Probe.
`OAuth2`	`getOauth2()`	ProbeSpec contains specification parameters for a Probe.
`List<ProbeParam>`	`getParams()`	The list of HTTP query parameters for the scrape.
`ProberSpec`	`getProber()`	ProbeSpec contains specification parameters for a Probe.
`Long`	`getSampleLimit()`	SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
`String`	`getScrapeClass()`	The scrape class to apply.
`Boolean`	`getScrapeClassicHistograms()`	Whether to scrape a classic histogram that is also exposed as a native histogram.
`List<String>`	`getScrapeProtocols()`	`scrapeProtocols` defines the protocols to negotiate during a scrape.
`String`	`getScrapeTimeout()`	Timeout for scraping metrics from the Prometheus exporter.
`Long`	`getTargetLimit()`	TargetLimit defines a limit on the number of scraped targets that will be accepted.
`ProbeTargets`	`getTargets()`	ProbeSpec contains specification parameters for a Probe.
`SafeTLSConfig`	`getTlsConfig()`	ProbeSpec contains specification parameters for a Probe.
`void`	`setAdditionalProperties(Map<String,Object> additionalProperties)`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setAuthorization(SafeAuthorization authorization)`	ProbeSpec contains specification parameters for a Probe.
`void`	`setBasicAuth(BasicAuth basicAuth)`	ProbeSpec contains specification parameters for a Probe.
`void`	`setBearerTokenSecret(io.fabric8.kubernetes.api.model.SecretKeySelector bearerTokenSecret)`	ProbeSpec contains specification parameters for a Probe.
`void`	`setConvertClassicHistogramsToNHCB(Boolean convertClassicHistogramsToNHCB)`	Whether to convert all scraped classic histograms into a native histogram with custom buckets.
`void`	`setFallbackScrapeProtocol(String fallbackScrapeProtocol)`	The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.
`void`	`setInterval(String interval)`	Interval at which targets are probed using the configured prober.
`void`	`setJobName(String jobName)`	The job name assigned to scraped metrics by default.
`void`	`setKeepDroppedTargets(Long keepDroppedTargets)`	Per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.
`void`	`setLabelLimit(Long labelLimit)`	Per-scrape limit on number of labels that will be accepted for a sample.
`void`	`setLabelNameLengthLimit(Long labelNameLengthLimit)`	Per-scrape limit on length of labels name that will be accepted for a sample.
`void`	`setLabelValueLengthLimit(Long labelValueLengthLimit)`	Per-scrape limit on length of labels value that will be accepted for a sample.
`void`	`setMetricRelabelings(List<RelabelConfig> metricRelabelings)`	MetricRelabelConfigs to apply to samples before ingestion.
`void`	`setModule(String module)`	The module to use for probing specifying how to probe the target.
`void`	`setNativeHistogramBucketLimit(Long nativeHistogramBucketLimit)`	If there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit.
`void`	`setNativeHistogramMinBucketFactor(io.fabric8.kubernetes.api.model.Quantity nativeHistogramMinBucketFactor)`	ProbeSpec contains specification parameters for a Probe.
`void`	`setOauth2(OAuth2 oauth2)`	ProbeSpec contains specification parameters for a Probe.
`void`	`setParams(List<ProbeParam> params)`	The list of HTTP query parameters for the scrape.
`void`	`setProber(ProberSpec prober)`	ProbeSpec contains specification parameters for a Probe.
`void`	`setSampleLimit(Long sampleLimit)`	SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
`void`	`setScrapeClass(String scrapeClass)`	The scrape class to apply.
`void`	`setScrapeClassicHistograms(Boolean scrapeClassicHistograms)`	Whether to scrape a classic histogram that is also exposed as a native histogram.
`void`	`setScrapeProtocols(List<String> scrapeProtocols)`	`scrapeProtocols` defines the protocols to negotiate during a scrape.
`void`	`setScrapeTimeout(String scrapeTimeout)`	Timeout for scraping metrics from the Prometheus exporter.
`void`	`setTargetLimit(Long targetLimit)`	TargetLimit defines a limit on the number of scraped targets that will be accepted.
`void`	`setTargets(ProbeTargets targets)`	ProbeSpec contains specification parameters for a Probe.
`void`	`setTlsConfig(SafeTLSConfig tlsConfig)`	ProbeSpec contains specification parameters for a Probe.
`ProbeSpecBuilder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProbeSpec
```
public ProbeSpec()
```
    No args constructor for use in serialization
  - ProbeSpec
```
public ProbeSpec(SafeAuthorization authorization,
                 BasicAuth basicAuth,
                 io.fabric8.kubernetes.api.model.SecretKeySelector bearerTokenSecret,
                 Boolean convertClassicHistogramsToNHCB,
                 String fallbackScrapeProtocol,
                 String interval,
                 String jobName,
                 Long keepDroppedTargets,
                 Long labelLimit,
                 Long labelNameLengthLimit,
                 Long labelValueLengthLimit,
                 List<RelabelConfig> metricRelabelings,
                 String module,
                 Long nativeHistogramBucketLimit,
                 io.fabric8.kubernetes.api.model.Quantity nativeHistogramMinBucketFactor,
                 OAuth2 oauth2,
                 List<ProbeParam> params,
                 ProberSpec prober,
                 Long sampleLimit,
                 String scrapeClass,
                 Boolean scrapeClassicHistograms,
                 List<String> scrapeProtocols,
                 String scrapeTimeout,
                 Long targetLimit,
                 ProbeTargets targets,
                 SafeTLSConfig tlsConfig)
```
- Method Detail
  - getAuthorization
```
public SafeAuthorization getAuthorization()
```
    ProbeSpec contains specification parameters for a Probe.
  - setAuthorization
```
public void setAuthorization(SafeAuthorization authorization)
```
    ProbeSpec contains specification parameters for a Probe.
  - getBasicAuth
```
public BasicAuth getBasicAuth()
```
    ProbeSpec contains specification parameters for a Probe.
  - setBasicAuth
```
public void setBasicAuth(BasicAuth basicAuth)
```
    ProbeSpec contains specification parameters for a Probe.
  - getBearerTokenSecret
```
public io.fabric8.kubernetes.api.model.SecretKeySelector getBearerTokenSecret()
```
    ProbeSpec contains specification parameters for a Probe.
  - setBearerTokenSecret
```
public void setBearerTokenSecret(io.fabric8.kubernetes.api.model.SecretKeySelector bearerTokenSecret)
```
    ProbeSpec contains specification parameters for a Probe.
  - getConvertClassicHistogramsToNHCB
```
public Boolean getConvertClassicHistogramsToNHCB()
```
    Whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0.
  - setConvertClassicHistogramsToNHCB
```
public void setConvertClassicHistogramsToNHCB(Boolean convertClassicHistogramsToNHCB)
```
    Whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0.
  - getFallbackScrapeProtocol
```
public String getFallbackScrapeProtocol()
```
    The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.
    
    It requires Prometheus >= v3.0.0.
  - setFallbackScrapeProtocol
```
public void setFallbackScrapeProtocol(String fallbackScrapeProtocol)
```
    The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.
    
    It requires Prometheus >= v3.0.0.
  - getInterval
```
public String getInterval()
```
    Interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used.
  - setInterval
```
public void setInterval(String interval)
```
    Interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used.
  - getJobName
```
public String getJobName()
```
    The job name assigned to scraped metrics by default.
  - setJobName
```
public void setJobName(String jobName)
```
    The job name assigned to scraped metrics by default.
  - getKeepDroppedTargets
```
public Long getKeepDroppedTargets()
```
    Per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.
    
    It requires Prometheus >= v2.47.0.
  - setKeepDroppedTargets
```
public void setKeepDroppedTargets(Long keepDroppedTargets)
```
    Per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit.
    
    It requires Prometheus >= v2.47.0.
  - getLabelLimit
```
public Long getLabelLimit()
```
    Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
  - setLabelLimit
```
public void setLabelLimit(Long labelLimit)
```
    Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
  - getLabelNameLengthLimit
```
public Long getLabelNameLengthLimit()
```
    Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
  - setLabelNameLengthLimit
```
public void setLabelNameLengthLimit(Long labelNameLengthLimit)
```
    Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
  - getLabelValueLengthLimit
```
public Long getLabelValueLengthLimit()
```
    Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
  - setLabelValueLengthLimit
```
public void setLabelValueLengthLimit(Long labelValueLengthLimit)
```
    Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
  - getMetricRelabelings
```
public List<RelabelConfig> getMetricRelabelings()
```
    MetricRelabelConfigs to apply to samples before ingestion.
  - setMetricRelabelings
```
public void setMetricRelabelings(List<RelabelConfig> metricRelabelings)
```
    MetricRelabelConfigs to apply to samples before ingestion.
  - getModule
```
public String getModule()
```
    The module to use for probing specifying how to probe the target. Example module configuring in the blackbox exporter: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml
  - setModule
```
public void setModule(String module)
```
    The module to use for probing specifying how to probe the target. Example module configuring in the blackbox exporter: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml
  - getNativeHistogramBucketLimit
```
public Long getNativeHistogramBucketLimit()
```
    If there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0.
  - setNativeHistogramBucketLimit
```
public void setNativeHistogramBucketLimit(Long nativeHistogramBucketLimit)
```
    If there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0.
  - getNativeHistogramMinBucketFactor
```
public io.fabric8.kubernetes.api.model.Quantity getNativeHistogramMinBucketFactor()
```
    ProbeSpec contains specification parameters for a Probe.
  - setNativeHistogramMinBucketFactor
```
public void setNativeHistogramMinBucketFactor(io.fabric8.kubernetes.api.model.Quantity nativeHistogramMinBucketFactor)
```
    ProbeSpec contains specification parameters for a Probe.
  - getOauth2
```
public OAuth2 getOauth2()
```
    ProbeSpec contains specification parameters for a Probe.
  - setOauth2
```
public void setOauth2(OAuth2 oauth2)
```
    ProbeSpec contains specification parameters for a Probe.
  - getParams
```
public List<ProbeParam> getParams()
```
    The list of HTTP query parameters for the scrape. Please note that the `.spec.module` field takes precedence over the `module` parameter from this list when both are defined. The module name must be added using Module under ProbeSpec.
  - setParams
```
public void setParams(List<ProbeParam> params)
```
    The list of HTTP query parameters for the scrape. Please note that the `.spec.module` field takes precedence over the `module` parameter from this list when both are defined. The module name must be added using Module under ProbeSpec.
  - getProber
```
public ProberSpec getProber()
```
    ProbeSpec contains specification parameters for a Probe.
  - setProber
```
public void setProber(ProberSpec prober)
```
    ProbeSpec contains specification parameters for a Probe.
  - getSampleLimit
```
public Long getSampleLimit()
```
    SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
  - setSampleLimit
```
public void setSampleLimit(Long sampleLimit)
```
    SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
  - getScrapeClass
```
public String getScrapeClass()
```
    The scrape class to apply.
  - setScrapeClass
```
public void setScrapeClass(String scrapeClass)
```
    The scrape class to apply.
  - getScrapeClassicHistograms
```
public Boolean getScrapeClassicHistograms()
```
    Whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0.
    
    Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.
  - setScrapeClassicHistograms
```
public void setScrapeClassicHistograms(Boolean scrapeClassicHistograms)
```
    Whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0.
    
    Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.
  - getScrapeProtocols
```
public List<String> getScrapeProtocols()
```
    `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred).
    
    If unset, Prometheus uses its default value.
    
    It requires Prometheus >= v2.49.0.
  - setScrapeProtocols
```
public void setScrapeProtocols(List<String> scrapeProtocols)
```
    `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred).
    
    If unset, Prometheus uses its default value.
    
    It requires Prometheus >= v2.49.0.
  - getScrapeTimeout
```
public String getScrapeTimeout()
```
    Timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape timeout is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
  - setScrapeTimeout
```
public void setScrapeTimeout(String scrapeTimeout)
```
    Timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape timeout is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
  - getTargetLimit
```
public Long getTargetLimit()
```
    TargetLimit defines a limit on the number of scraped targets that will be accepted.
  - setTargetLimit
```
public void setTargetLimit(Long targetLimit)
```
    TargetLimit defines a limit on the number of scraped targets that will be accepted.
  - getTargets
```
public ProbeTargets getTargets()
```
    ProbeSpec contains specification parameters for a Probe.
  - setTargets
```
public void setTargets(ProbeTargets targets)
```
    ProbeSpec contains specification parameters for a Probe.
  - getTlsConfig
```
public SafeTLSConfig getTlsConfig()
```
    ProbeSpec contains specification parameters for a Probe.
  - setTlsConfig
```
public void setTlsConfig(SafeTLSConfig tlsConfig)
```
    ProbeSpec contains specification parameters for a Probe.
  - edit
```
public ProbeSpecBuilder edit()
```
    Specified by:
    
    edit in interface io.fabric8.kubernetes.api.builder.Editable<ProbeSpecBuilder>
  - toBuilder
```
public ProbeSpecBuilder toBuilder()
```
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,Object> additionalProperties)
```

Class ProbeSpec

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProbeSpec

ProbeSpec

Method Detail

getAuthorization

setAuthorization

getBasicAuth

setBasicAuth

getBearerTokenSecret

setBearerTokenSecret

getConvertClassicHistogramsToNHCB

setConvertClassicHistogramsToNHCB

getFallbackScrapeProtocol

setFallbackScrapeProtocol

getInterval

setInterval

getJobName

setJobName

getKeepDroppedTargets

setKeepDroppedTargets

getLabelLimit

setLabelLimit

getLabelNameLengthLimit

setLabelNameLengthLimit

getLabelValueLengthLimit

setLabelValueLengthLimit

getMetricRelabelings

setMetricRelabelings

getModule

setModule

getNativeHistogramBucketLimit

setNativeHistogramBucketLimit

getNativeHistogramMinBucketFactor

setNativeHistogramMinBucketFactor

getOauth2

setOauth2

getParams

setParams

getProber

setProber

getSampleLimit

setSampleLimit

getScrapeClass

setScrapeClass

getScrapeClassicHistograms

setScrapeClassicHistograms

getScrapeProtocols

setScrapeProtocols

getScrapeTimeout

setScrapeTimeout

getTargetLimit

setTargetLimit

getTargets

setTargets

getTlsConfig

setTlsConfig

edit

toBuilder

getAdditionalProperties

setAdditionalProperty

setAdditionalProperties