Package-level declarations

Types

Link copied to clipboard
data class ContainerResourceMetricSource(val container: String, val name: String, val target: MetricTarget)

ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

Link copied to clipboard
data class ContainerResourceMetricSourcePatch(val container: String? = null, val name: String? = null, val target: MetricTargetPatch? = null)

ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

Link copied to clipboard
data class ContainerResourceMetricStatus(val container: String, val current: MetricValueStatus, val name: String)

ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

Link copied to clipboard
data class ContainerResourceMetricStatusPatch(val container: String? = null, val current: MetricValueStatusPatch? = null, val name: String? = null)

ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

Link copied to clipboard
data class CrossVersionObjectReference(val apiVersion: String? = null, val kind: String, val name: String)

CrossVersionObjectReference contains enough information to let you identify the referred resource.

Link copied to clipboard
data class CrossVersionObjectReferencePatch(val apiVersion: String? = null, val kind: String? = null, val name: String? = null)

CrossVersionObjectReference contains enough information to let you identify the referred resource.

Link copied to clipboard
data class ExternalMetricSource(val metric: MetricIdentifier, val target: MetricTarget)

ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).

Link copied to clipboard
data class ExternalMetricSourcePatch(val metric: MetricIdentifierPatch? = null, val target: MetricTargetPatch? = null)

ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).

Link copied to clipboard
data class ExternalMetricStatus(val current: MetricValueStatus, val metric: MetricIdentifier)

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

Link copied to clipboard
data class ExternalMetricStatusPatch(val current: MetricValueStatusPatch? = null, val metric: MetricIdentifierPatch? = null)

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

Link copied to clipboard
data class HorizontalPodAutoscaler(val apiVersion: String? = null, val kind: String? = null, val metadata: ObjectMeta? = null, val spec: HorizontalPodAutoscalerSpec? = null, val status: HorizontalPodAutoscalerStatus? = null)

HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

Link copied to clipboard
data class HorizontalPodAutoscalerBehavior(val scaleDown: HPAScalingRules? = null, val scaleUp: HPAScalingRules? = null)

HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).

Link copied to clipboard
data class HorizontalPodAutoscalerBehaviorPatch(val scaleDown: HPAScalingRulesPatch? = null, val scaleUp: HPAScalingRulesPatch? = null)

HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).

Link copied to clipboard
data class HorizontalPodAutoscalerCondition(val lastTransitionTime: String? = null, val message: String? = null, val reason: String? = null, val status: String, val type: String)

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

Link copied to clipboard
data class HorizontalPodAutoscalerConditionPatch(val lastTransitionTime: String? = null, val message: String? = null, val reason: String? = null, val status: String? = null, val type: String? = null)

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

Link copied to clipboard
data class HorizontalPodAutoscalerSpec(val behavior: HorizontalPodAutoscalerBehavior? = null, val maxReplicas: Int, val metrics: List<MetricSpec>? = null, val minReplicas: Int? = null, val scaleTargetRef: CrossVersionObjectReference)

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

Link copied to clipboard
data class HorizontalPodAutoscalerSpecPatch(val behavior: HorizontalPodAutoscalerBehaviorPatch? = null, val maxReplicas: Int? = null, val metrics: List<MetricSpecPatch>? = null, val minReplicas: Int? = null, val scaleTargetRef: CrossVersionObjectReferencePatch? = null)

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

Link copied to clipboard
data class HorizontalPodAutoscalerStatus(val conditions: List<HorizontalPodAutoscalerCondition>? = null, val currentMetrics: List<MetricStatus>? = null, val currentReplicas: Int? = null, val desiredReplicas: Int, val lastScaleTime: String? = null, val observedGeneration: Int? = null)

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

Link copied to clipboard
data class HorizontalPodAutoscalerStatusPatch(val conditions: List<HorizontalPodAutoscalerConditionPatch>? = null, val currentMetrics: List<MetricStatusPatch>? = null, val currentReplicas: Int? = null, val desiredReplicas: Int? = null, val lastScaleTime: String? = null, val observedGeneration: Int? = null)

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

Link copied to clipboard
data class HPAScalingPolicy(val periodSeconds: Int, val type: String, val value: Int)

HPAScalingPolicy is a single policy which must hold true for a specified past interval.

Link copied to clipboard
data class HPAScalingPolicyPatch(val periodSeconds: Int? = null, val type: String? = null, val value: Int? = null)

HPAScalingPolicy is a single policy which must hold true for a specified past interval.

Link copied to clipboard
data class HPAScalingRules(val policies: List<HPAScalingPolicy>? = null, val selectPolicy: String? = null, val stabilizationWindowSeconds: Int? = null)

HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.

Link copied to clipboard
data class HPAScalingRulesPatch(val policies: List<HPAScalingPolicyPatch>? = null, val selectPolicy: String? = null, val stabilizationWindowSeconds: Int? = null)

HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.

Link copied to clipboard
data class MetricIdentifier(val name: String, val selector: LabelSelector? = null)

MetricIdentifier defines the name and optionally selector for a metric

Link copied to clipboard
data class MetricIdentifierPatch(val name: String? = null, val selector: LabelSelectorPatch? = null)

MetricIdentifier defines the name and optionally selector for a metric

Link copied to clipboard
data class MetricSpec(val containerResource: ContainerResourceMetricSource? = null, val external: ExternalMetricSource? = null, val object: ObjectMetricSource? = null, val pods: PodsMetricSource? = null, val resource: ResourceMetricSource? = null, val type: String)

MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once).

Link copied to clipboard
data class MetricSpecPatch(val containerResource: ContainerResourceMetricSourcePatch? = null, val external: ExternalMetricSourcePatch? = null, val object: ObjectMetricSourcePatch? = null, val pods: PodsMetricSourcePatch? = null, val resource: ResourceMetricSourcePatch? = null, val type: String? = null)

MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once).

Link copied to clipboard
data class MetricStatus(val containerResource: ContainerResourceMetricStatus? = null, val external: ExternalMetricStatus? = null, val object: ObjectMetricStatus? = null, val pods: PodsMetricStatus? = null, val resource: ResourceMetricStatus? = null, val type: String)

MetricStatus describes the last-read state of a single metric.

Link copied to clipboard
data class MetricStatusPatch(val containerResource: ContainerResourceMetricStatusPatch? = null, val external: ExternalMetricStatusPatch? = null, val object: ObjectMetricStatusPatch? = null, val pods: PodsMetricStatusPatch? = null, val resource: ResourceMetricStatusPatch? = null, val type: String? = null)

MetricStatus describes the last-read state of a single metric.

Link copied to clipboard
data class MetricTarget(val averageUtilization: Int? = null, val averageValue: String? = null, val type: String, val value: String? = null)

MetricTarget defines the target value, average value, or average utilization of a specific metric

Link copied to clipboard
data class MetricTargetPatch(val averageUtilization: Int? = null, val averageValue: String? = null, val type: String? = null, val value: String? = null)

MetricTarget defines the target value, average value, or average utilization of a specific metric

Link copied to clipboard
data class MetricValueStatus(val averageUtilization: Int? = null, val averageValue: String? = null, val value: String? = null)

MetricValueStatus holds the current value for a metric

Link copied to clipboard
data class MetricValueStatusPatch(val averageUtilization: Int? = null, val averageValue: String? = null, val value: String? = null)

MetricValueStatus holds the current value for a metric

Link copied to clipboard
data class ObjectMetricSource(val describedObject: CrossVersionObjectReference, val metric: MetricIdentifier, val target: MetricTarget)

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Link copied to clipboard
data class ObjectMetricSourcePatch(val describedObject: CrossVersionObjectReferencePatch? = null, val metric: MetricIdentifierPatch? = null, val target: MetricTargetPatch? = null)

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Link copied to clipboard
data class ObjectMetricStatus(val current: MetricValueStatus, val describedObject: CrossVersionObjectReference, val metric: MetricIdentifier)

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Link copied to clipboard
data class ObjectMetricStatusPatch(val current: MetricValueStatusPatch? = null, val describedObject: CrossVersionObjectReferencePatch? = null, val metric: MetricIdentifierPatch? = null)

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Link copied to clipboard
data class PodsMetricSource(val metric: MetricIdentifier, val target: MetricTarget)

PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.

Link copied to clipboard
data class PodsMetricSourcePatch(val metric: MetricIdentifierPatch? = null, val target: MetricTargetPatch? = null)

PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.

Link copied to clipboard
data class PodsMetricStatus(val current: MetricValueStatus, val metric: MetricIdentifier)

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

Link copied to clipboard
data class PodsMetricStatusPatch(val current: MetricValueStatusPatch? = null, val metric: MetricIdentifierPatch? = null)

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

Link copied to clipboard
data class ResourceMetricSource(val name: String, val target: MetricTarget)

ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

Link copied to clipboard
data class ResourceMetricSourcePatch(val name: String? = null, val target: MetricTargetPatch? = null)

ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

Link copied to clipboard
data class ResourceMetricStatus(val current: MetricValueStatus, val name: String)

ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

Link copied to clipboard
data class ResourceMetricStatusPatch(val current: MetricValueStatusPatch? = null, val name: String? = null)

ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.