Package io.fabric8.openshift.api.model.monitoring.v1

Class Probe

java.lang.Object

io.fabric8.openshift.api.model.monitoring.v1.Probe

All Implemented Interfaces:

Editable<ProbeBuilder>, HasMetadata, KubernetesResource, Namespaced, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class Probe
extends Object
implements Editable<ProbeBuilder>, HasMetadata, Namespaced

The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).

The `Probe` resource needs 2 pieces of information: * The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects. * The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, ...) as Prometheus metrics.

`Prometheus` and `PrometheusAgent` objects select `Probe` objects using label and namespace selectors.

See Also:

Serialized Form

Field Summary

Fields inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

DNS_LABEL_END, DNS_LABEL_REGEXP, DNS_LABEL_START, FINALIZER_NAME_MATCHER, REQUIRES_NON_NULL_METADATA, REQUIRES_NON_NULL_NAME, REQUIRES_NON_NULL_NAMESPACE

Constructor Summary

Constructors

Constructor	Description
Probe()	No args constructor for use in serialization
Probe(String apiVersion, String kind, ObjectMeta metadata, ProbeSpec spec, ConfigResourceStatus status)

Method Summary

Modifier and Type	Method	Description
ProbeBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getApiVersion()	APIVersion defines the versioned schema of this representation of an object.
String	getKind()	Kind is a string value representing the REST resource this object represents.
ObjectMeta	getMetadata()	The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).
ProbeSpec	getSpec()	The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).
ConfigResourceStatus	getStatus()	The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setApiVersion(String apiVersion)	APIVersion defines the versioned schema of this representation of an object.
void	setKind(String kind)	Kind is a string value representing the REST resource this object represents.
void	setMetadata(ObjectMeta metadata)	The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).
void	setSpec(ProbeSpec spec)	The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).
void	setStatus(ConfigResourceStatus status)	The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).
ProbeBuilder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

addFinalizer, addOwnerReference, addOwnerReference, addOwnerReference, getFinalizers, getFullResourceName, getOwnerReferenceFor, getOwnerReferenceFor, getPlural, getSingular, hasFinalizer, hasOwnerReferenceFor, hasOwnerReferenceFor, initNameAndNamespaceFrom, isFinalizerValid, isMarkedForDeletion, isSameResource, isSameResource, optionalMetadata, removeFinalizer, removeOwnerReference, removeOwnerReference

Constructor Detail

Probe

public Probe()

No args constructor for use in serialization

Probe

public Probe(String apiVersion,
             String kind,
             ObjectMeta metadata,
             ProbeSpec spec,
             ConfigResourceStatus status)

Method Detail

getApiVersion

public String getApiVersion()

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Specified by:

getApiVersion in interface HasMetadata

setApiVersion

public void setApiVersion(String apiVersion)

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Specified by:

setApiVersion in interface HasMetadata

getKind

public String getKind()

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Specified by:

getKind in interface HasMetadata

setKind

public void setKind(String kind)

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

getMetadata

public ObjectMeta getMetadata()

The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).

The `Probe` resource needs 2 pieces of information: * The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects. * The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, ...) as Prometheus metrics.

`Prometheus` and `PrometheusAgent` objects select `Probe` objects using label and namespace selectors.

Specified by:

getMetadata in interface HasMetadata

setMetadata

public void setMetadata(ObjectMeta metadata)

The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).

The `Probe` resource needs 2 pieces of information: * The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects. * The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, ...) as Prometheus metrics.

`Prometheus` and `PrometheusAgent` objects select `Probe` objects using label and namespace selectors.

Specified by:

setMetadata in interface HasMetadata

getSpec

public ProbeSpec getSpec()

The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).

The `Probe` resource needs 2 pieces of information: * The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects. * The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, ...) as Prometheus metrics.

`Prometheus` and `PrometheusAgent` objects select `Probe` objects using label and namespace selectors.

setSpec

public void setSpec(ProbeSpec spec)

The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).

The `Probe` resource needs 2 pieces of information: * The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects. * The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, ...) as Prometheus metrics.

`Prometheus` and `PrometheusAgent` objects select `Probe` objects using label and namespace selectors.

getStatus

public ConfigResourceStatus getStatus()

The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).

The `Probe` resource needs 2 pieces of information: * The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects. * The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, ...) as Prometheus metrics.

`Prometheus` and `PrometheusAgent` objects select `Probe` objects using label and namespace selectors.

setStatus

public void setStatus(ConfigResourceStatus status)

The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).

The `Probe` resource needs 2 pieces of information: * The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects. * The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, ...) as Prometheus metrics.

`Prometheus` and `PrometheusAgent` objects select `Probe` objects using label and namespace selectors.

edit

public ProbeBuilder edit()

Specified by:

edit in interface Editable<ProbeBuilder>

toBuilder

public ProbeBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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