ptctools 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

ptctools/portainer_client/openapi_client/docs/V2HPAScalingPolicy.md

@@ -0,0 +1,31 @@
+# V2HPAScalingPolicy
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**period_seconds** | **int** | periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min). | [optional] 
+**type** | [**V2HPAScalingPolicyType**](V2HPAScalingPolicyType.md) | type is used to specify the scaling policy. | [optional] 
+**value** | **int** | value contains the amount of change which is permitted by the policy. It must be greater than zero | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_hpa_scaling_policy import V2HPAScalingPolicy
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2HPAScalingPolicy from a JSON string
+v2_hpa_scaling_policy_instance = V2HPAScalingPolicy.from_json(json)
+# print the JSON string representation of the object
+print(V2HPAScalingPolicy.to_json())
+
+# convert the object into a dict
+v2_hpa_scaling_policy_dict = v2_hpa_scaling_policy_instance.to_dict()
+# create an instance of V2HPAScalingPolicy from a dict
+v2_hpa_scaling_policy_from_dict = V2HPAScalingPolicy.from_dict(v2_hpa_scaling_policy_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2HPAScalingPolicyType.md

@@ -0,0 +1,12 @@
+# V2HPAScalingPolicyType
+
+
+## Enum
+
+* `PodsScalingPolicy` (value: `'Pods'`)
+
+* `PercentScalingPolicy` (value: `'Percent'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2HPAScalingRules.md

@@ -0,0 +1,32 @@
+# V2HPAScalingRules
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**policies** | [**List[V2HPAScalingPolicy]**](V2HPAScalingPolicy.md) | policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window. +listType=atomic +optional | [optional] 
+**select_policy** | [**V2ScalingPolicySelect**](V2ScalingPolicySelect.md) | selectPolicy is used to specify which policy should be used. If not set, the default value Max is used. +optional | [optional] 
+**stabilization_window_seconds** | **int** | stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long). +optional | [optional] 
+**tolerance** | [**ResourceQuantity**](ResourceQuantity.md) | tolerance is the tolerance on the ratio between the current and desired metric value under which no updates are made to the desired number of replicas (e.g. 0.01 for 1%). Must be greater than or equal to zero. If not set, the default cluster-wide tolerance is applied (by default 10%).  For example, if autoscaling is configured with a memory consumption target of 100Mi, and scale-down and scale-up tolerances of 5% and 1% respectively, scaling will be triggered when the actual consumption falls below 95Mi or exceeds 101Mi.  This is an alpha field and requires enabling the HPAConfigurableTolerance feature gate.  +featureGate=HPAConfigurableTolerance +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_hpa_scaling_rules import V2HPAScalingRules
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2HPAScalingRules from a JSON string
+v2_hpa_scaling_rules_instance = V2HPAScalingRules.from_json(json)
+# print the JSON string representation of the object
+print(V2HPAScalingRules.to_json())
+
+# convert the object into a dict
+v2_hpa_scaling_rules_dict = v2_hpa_scaling_rules_instance.to_dict()
+# create an instance of V2HPAScalingRules from a dict
+v2_hpa_scaling_rules_from_dict = V2HPAScalingRules.from_dict(v2_hpa_scaling_rules_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2HorizontalPodAutoscaler.md

@@ -0,0 +1,33 @@
+# V2HorizontalPodAutoscaler
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_version** | **str** | 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 +optional | [optional] 
+**kind** | **str** | 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 +optional | [optional] 
+**metadata** | [**V1ObjectMeta**](V1ObjectMeta.md) | metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | [optional] 
+**spec** | [**V2HorizontalPodAutoscalerSpec**](V2HorizontalPodAutoscalerSpec.md) | spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. +optional | [optional] 
+**status** | [**V2HorizontalPodAutoscalerStatus**](V2HorizontalPodAutoscalerStatus.md) | status is the current information about the autoscaler. +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_horizontal_pod_autoscaler import V2HorizontalPodAutoscaler
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2HorizontalPodAutoscaler from a JSON string
+v2_horizontal_pod_autoscaler_instance = V2HorizontalPodAutoscaler.from_json(json)
+# print the JSON string representation of the object
+print(V2HorizontalPodAutoscaler.to_json())
+
+# convert the object into a dict
+v2_horizontal_pod_autoscaler_dict = v2_horizontal_pod_autoscaler_instance.to_dict()
+# create an instance of V2HorizontalPodAutoscaler from a dict
+v2_horizontal_pod_autoscaler_from_dict = V2HorizontalPodAutoscaler.from_dict(v2_horizontal_pod_autoscaler_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2HorizontalPodAutoscalerBehavior.md

@@ -0,0 +1,30 @@
+# V2HorizontalPodAutoscalerBehavior
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scale_down** | [**V2HPAScalingRules**](V2HPAScalingRules.md) | scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used). +optional | [optional] 
+**scale_up** | [**V2HPAScalingRules**](V2HPAScalingRules.md) | scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of:   * increase no more than 4 pods per 60 seconds   * double the number of pods per 60 seconds No stabilization is used. +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_horizontal_pod_autoscaler_behavior import V2HorizontalPodAutoscalerBehavior
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2HorizontalPodAutoscalerBehavior from a JSON string
+v2_horizontal_pod_autoscaler_behavior_instance = V2HorizontalPodAutoscalerBehavior.from_json(json)
+# print the JSON string representation of the object
+print(V2HorizontalPodAutoscalerBehavior.to_json())
+
+# convert the object into a dict
+v2_horizontal_pod_autoscaler_behavior_dict = v2_horizontal_pod_autoscaler_behavior_instance.to_dict()
+# create an instance of V2HorizontalPodAutoscalerBehavior from a dict
+v2_horizontal_pod_autoscaler_behavior_from_dict = V2HorizontalPodAutoscalerBehavior.from_dict(v2_horizontal_pod_autoscaler_behavior_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2HorizontalPodAutoscalerCondition.md

@@ -0,0 +1,33 @@
+# V2HorizontalPodAutoscalerCondition
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_transition_time** | **str** | lastTransitionTime is the last time the condition transitioned from one status to another +optional | [optional] 
+**message** | **str** | message is a human-readable explanation containing details about the transition +optional | [optional] 
+**reason** | **str** | reason is the reason for the condition's last transition. +optional | [optional] 
+**status** | [**K8sIoApiCoreV1ConditionStatus**](K8sIoApiCoreV1ConditionStatus.md) | status is the status of the condition (True, False, Unknown) | [optional] 
+**type** | [**V2HorizontalPodAutoscalerConditionType**](V2HorizontalPodAutoscalerConditionType.md) | type describes the current condition | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_horizontal_pod_autoscaler_condition import V2HorizontalPodAutoscalerCondition
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2HorizontalPodAutoscalerCondition from a JSON string
+v2_horizontal_pod_autoscaler_condition_instance = V2HorizontalPodAutoscalerCondition.from_json(json)
+# print the JSON string representation of the object
+print(V2HorizontalPodAutoscalerCondition.to_json())
+
+# convert the object into a dict
+v2_horizontal_pod_autoscaler_condition_dict = v2_horizontal_pod_autoscaler_condition_instance.to_dict()
+# create an instance of V2HorizontalPodAutoscalerCondition from a dict
+v2_horizontal_pod_autoscaler_condition_from_dict = V2HorizontalPodAutoscalerCondition.from_dict(v2_horizontal_pod_autoscaler_condition_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2HorizontalPodAutoscalerConditionType.md

@@ -0,0 +1,14 @@
+# V2HorizontalPodAutoscalerConditionType
+
+
+## Enum
+
+* `ScalingActive` (value: `'ScalingActive'`)
+
+* `AbleToScale` (value: `'AbleToScale'`)
+
+* `ScalingLimited` (value: `'ScalingLimited'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2HorizontalPodAutoscalerSpec.md

@@ -0,0 +1,33 @@
+# V2HorizontalPodAutoscalerSpec
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**behavior** | [**V2HorizontalPodAutoscalerBehavior**](V2HorizontalPodAutoscalerBehavior.md) | behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used. +optional | [optional] 
+**max_replicas** | **int** | maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. | [optional] 
+**metrics** | [**List[V2MetricSpec]**](V2MetricSpec.md) | metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used).  The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods.  Ergo, metrics used must decrease as the pod count is increased, and vice-versa.  See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization. +listType=atomic +optional | [optional] 
+**min_replicas** | **int** | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.  It defaults to 1 pod.  minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured.  Scaling is active as long as at least one metric value is available. +optional | [optional] 
+**scale_target_ref** | [**V2CrossVersionObjectReference**](V2CrossVersionObjectReference.md) | scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_horizontal_pod_autoscaler_spec import V2HorizontalPodAutoscalerSpec
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2HorizontalPodAutoscalerSpec from a JSON string
+v2_horizontal_pod_autoscaler_spec_instance = V2HorizontalPodAutoscalerSpec.from_json(json)
+# print the JSON string representation of the object
+print(V2HorizontalPodAutoscalerSpec.to_json())
+
+# convert the object into a dict
+v2_horizontal_pod_autoscaler_spec_dict = v2_horizontal_pod_autoscaler_spec_instance.to_dict()
+# create an instance of V2HorizontalPodAutoscalerSpec from a dict
+v2_horizontal_pod_autoscaler_spec_from_dict = V2HorizontalPodAutoscalerSpec.from_dict(v2_horizontal_pod_autoscaler_spec_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2HorizontalPodAutoscalerStatus.md

@@ -0,0 +1,34 @@
+# V2HorizontalPodAutoscalerStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conditions** | [**List[V2HorizontalPodAutoscalerCondition]**](V2HorizontalPodAutoscalerCondition.md) | conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met. +patchMergeKey=type +patchStrategy=merge +listType=map +listMapKey=type +optional | [optional] 
+**current_metrics** | [**List[V2MetricStatus]**](V2MetricStatus.md) | currentMetrics is the last read state of the metrics used by this autoscaler. +listType=atomic +optional | [optional] 
+**current_replicas** | **int** | currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler. +optional | [optional] 
+**desired_replicas** | **int** | desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler. | [optional] 
+**last_scale_time** | **str** | lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed. +optional | [optional] 
+**observed_generation** | **int** | observedGeneration is the most recent generation observed by this autoscaler. +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_horizontal_pod_autoscaler_status import V2HorizontalPodAutoscalerStatus
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2HorizontalPodAutoscalerStatus from a JSON string
+v2_horizontal_pod_autoscaler_status_instance = V2HorizontalPodAutoscalerStatus.from_json(json)
+# print the JSON string representation of the object
+print(V2HorizontalPodAutoscalerStatus.to_json())
+
+# convert the object into a dict
+v2_horizontal_pod_autoscaler_status_dict = v2_horizontal_pod_autoscaler_status_instance.to_dict()
+# create an instance of V2HorizontalPodAutoscalerStatus from a dict
+v2_horizontal_pod_autoscaler_status_from_dict = V2HorizontalPodAutoscalerStatus.from_dict(v2_horizontal_pod_autoscaler_status_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2MetricIdentifier.md

@@ -0,0 +1,30 @@
+# V2MetricIdentifier
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | name is the name of the given metric | [optional] 
+**selector** | [**V1LabelSelector**](V1LabelSelector.md) | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics. +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_metric_identifier import V2MetricIdentifier
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2MetricIdentifier from a JSON string
+v2_metric_identifier_instance = V2MetricIdentifier.from_json(json)
+# print the JSON string representation of the object
+print(V2MetricIdentifier.to_json())
+
+# convert the object into a dict
+v2_metric_identifier_dict = v2_metric_identifier_instance.to_dict()
+# create an instance of V2MetricIdentifier from a dict
+v2_metric_identifier_from_dict = V2MetricIdentifier.from_dict(v2_metric_identifier_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2MetricSourceType.md

@@ -0,0 +1,18 @@
+# V2MetricSourceType
+
+
+## Enum
+
+* `ObjectMetricSourceType` (value: `'Object'`)
+
+* `PodsMetricSourceType` (value: `'Pods'`)
+
+* `ResourceMetricSourceType` (value: `'Resource'`)
+
+* `ContainerResourceMetricSourceType` (value: `'ContainerResource'`)
+
+* `ExternalMetricSourceType` (value: `'External'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2MetricSpec.md

@@ -0,0 +1,34 @@
+# V2MetricSpec
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**container_resource** | [**V2ContainerResourceMetricSource**](V2ContainerResourceMetricSource.md) | containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of 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. +optional | [optional] 
+**external** | [**V2ExternalMetricSource**](V2ExternalMetricSource.md) | external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). +optional | [optional] 
+**object** | [**V2ObjectMetricSource**](V2ObjectMetricSource.md) | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). +optional | [optional] 
+**pods** | [**V2PodsMetricSource**](V2PodsMetricSource.md) | pods refers to 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. +optional | [optional] 
+**resource** | [**V2ResourceMetricSource**](V2ResourceMetricSource.md) | resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes 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. +optional | [optional] 
+**type** | [**V2MetricSourceType**](V2MetricSourceType.md) | type is the type of metric source.  It should be one of \"ContainerResource\", \"External\", \"Object\", \"Pods\" or \"Resource\", each mapping to a matching field in the object. | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_metric_spec import V2MetricSpec
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2MetricSpec from a JSON string
+v2_metric_spec_instance = V2MetricSpec.from_json(json)
+# print the JSON string representation of the object
+print(V2MetricSpec.to_json())
+
+# convert the object into a dict
+v2_metric_spec_dict = v2_metric_spec_instance.to_dict()
+# create an instance of V2MetricSpec from a dict
+v2_metric_spec_from_dict = V2MetricSpec.from_dict(v2_metric_spec_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2MetricStatus.md

@@ -0,0 +1,34 @@
+# V2MetricStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**container_resource** | [**V2ContainerResourceMetricStatus**](V2ContainerResourceMetricStatus.md) | container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes 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. +optional | [optional] 
+**external** | [**V2ExternalMetricStatus**](V2ExternalMetricStatus.md) | external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). +optional | [optional] 
+**object** | [**V2ObjectMetricStatus**](V2ObjectMetricStatus.md) | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). +optional | [optional] 
+**pods** | [**V2PodsMetricStatus**](V2PodsMetricStatus.md) | pods refers to 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. +optional | [optional] 
+**resource** | [**V2ResourceMetricStatus**](V2ResourceMetricStatus.md) | resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes 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. +optional | [optional] 
+**type** | [**V2MetricSourceType**](V2MetricSourceType.md) | type is the type of metric source.  It will be one of \"ContainerResource\", \"External\", \"Object\", \"Pods\" or \"Resource\", each corresponds to a matching field in the object. | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_metric_status import V2MetricStatus
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2MetricStatus from a JSON string
+v2_metric_status_instance = V2MetricStatus.from_json(json)
+# print the JSON string representation of the object
+print(V2MetricStatus.to_json())
+
+# convert the object into a dict
+v2_metric_status_dict = v2_metric_status_instance.to_dict()
+# create an instance of V2MetricStatus from a dict
+v2_metric_status_from_dict = V2MetricStatus.from_dict(v2_metric_status_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2MetricTarget.md

@@ -0,0 +1,32 @@
+# V2MetricTarget
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**average_utilization** | **int** | averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type +optional | [optional] 
+**average_value** | [**ResourceQuantity**](ResourceQuantity.md) | averageValue is the target value of the average of the metric across all relevant pods (as a quantity) +optional | [optional] 
+**type** | [**V2MetricTargetType**](V2MetricTargetType.md) | type represents whether the metric type is Utilization, Value, or AverageValue | [optional] 
+**value** | [**ResourceQuantity**](ResourceQuantity.md) | value is the target value of the metric (as a quantity). +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_metric_target import V2MetricTarget
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2MetricTarget from a JSON string
+v2_metric_target_instance = V2MetricTarget.from_json(json)
+# print the JSON string representation of the object
+print(V2MetricTarget.to_json())
+
+# convert the object into a dict
+v2_metric_target_dict = v2_metric_target_instance.to_dict()
+# create an instance of V2MetricTarget from a dict
+v2_metric_target_from_dict = V2MetricTarget.from_dict(v2_metric_target_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2MetricTargetType.md

@@ -0,0 +1,14 @@
+# V2MetricTargetType
+
+
+## Enum
+
+* `UtilizationMetricType` (value: `'Utilization'`)
+
+* `ValueMetricType` (value: `'Value'`)
+
+* `AverageValueMetricType` (value: `'AverageValue'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2MetricValueStatus.md

@@ -0,0 +1,31 @@
+# V2MetricValueStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**average_utilization** | **int** | currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. +optional | [optional] 
+**average_value** | [**ResourceQuantity**](ResourceQuantity.md) | averageValue is the current value of the average of the metric across all relevant pods (as a quantity) +optional | [optional] 
+**value** | [**ResourceQuantity**](ResourceQuantity.md) | value is the current value of the metric (as a quantity). +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_metric_value_status import V2MetricValueStatus
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2MetricValueStatus from a JSON string
+v2_metric_value_status_instance = V2MetricValueStatus.from_json(json)
+# print the JSON string representation of the object
+print(V2MetricValueStatus.to_json())
+
+# convert the object into a dict
+v2_metric_value_status_dict = v2_metric_value_status_instance.to_dict()
+# create an instance of V2MetricValueStatus from a dict
+v2_metric_value_status_from_dict = V2MetricValueStatus.from_dict(v2_metric_value_status_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2ObjectMetricSource.md

@@ -0,0 +1,31 @@
+# V2ObjectMetricSource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**described_object** | [**V2CrossVersionObjectReference**](V2CrossVersionObjectReference.md) | describedObject specifies the descriptions of a object,such as kind,name apiVersion | [optional] 
+**metric** | [**V2MetricIdentifier**](V2MetricIdentifier.md) | metric identifies the target metric by name and selector | [optional] 
+**target** | [**V2MetricTarget**](V2MetricTarget.md) | target specifies the target value for the given metric | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_object_metric_source import V2ObjectMetricSource
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2ObjectMetricSource from a JSON string
+v2_object_metric_source_instance = V2ObjectMetricSource.from_json(json)
+# print the JSON string representation of the object
+print(V2ObjectMetricSource.to_json())
+
+# convert the object into a dict
+v2_object_metric_source_dict = v2_object_metric_source_instance.to_dict()
+# create an instance of V2ObjectMetricSource from a dict
+v2_object_metric_source_from_dict = V2ObjectMetricSource.from_dict(v2_object_metric_source_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2ObjectMetricStatus.md

@@ -0,0 +1,31 @@
+# V2ObjectMetricStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current** | [**V2MetricValueStatus**](V2MetricValueStatus.md) | current contains the current value for the given metric | [optional] 
+**described_object** | [**V2CrossVersionObjectReference**](V2CrossVersionObjectReference.md) | DescribedObject specifies the descriptions of a object,such as kind,name apiVersion | [optional] 
+**metric** | [**V2MetricIdentifier**](V2MetricIdentifier.md) | metric identifies the target metric by name and selector | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_object_metric_status import V2ObjectMetricStatus
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2ObjectMetricStatus from a JSON string
+v2_object_metric_status_instance = V2ObjectMetricStatus.from_json(json)
+# print the JSON string representation of the object
+print(V2ObjectMetricStatus.to_json())
+
+# convert the object into a dict
+v2_object_metric_status_dict = v2_object_metric_status_instance.to_dict()
+# create an instance of V2ObjectMetricStatus from a dict
+v2_object_metric_status_from_dict = V2ObjectMetricStatus.from_dict(v2_object_metric_status_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2PodsMetricSource.md

@@ -0,0 +1,30 @@
+# V2PodsMetricSource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metric** | [**V2MetricIdentifier**](V2MetricIdentifier.md) | metric identifies the target metric by name and selector | [optional] 
+**target** | [**V2MetricTarget**](V2MetricTarget.md) | target specifies the target value for the given metric | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_pods_metric_source import V2PodsMetricSource
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2PodsMetricSource from a JSON string
+v2_pods_metric_source_instance = V2PodsMetricSource.from_json(json)
+# print the JSON string representation of the object
+print(V2PodsMetricSource.to_json())
+
+# convert the object into a dict
+v2_pods_metric_source_dict = v2_pods_metric_source_instance.to_dict()
+# create an instance of V2PodsMetricSource from a dict
+v2_pods_metric_source_from_dict = V2PodsMetricSource.from_dict(v2_pods_metric_source_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2PodsMetricStatus.md

@@ -0,0 +1,30 @@
+# V2PodsMetricStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current** | [**V2MetricValueStatus**](V2MetricValueStatus.md) | current contains the current value for the given metric | [optional] 
+**metric** | [**V2MetricIdentifier**](V2MetricIdentifier.md) | metric identifies the target metric by name and selector | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_pods_metric_status import V2PodsMetricStatus
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2PodsMetricStatus from a JSON string
+v2_pods_metric_status_instance = V2PodsMetricStatus.from_json(json)
+# print the JSON string representation of the object
+print(V2PodsMetricStatus.to_json())
+
+# convert the object into a dict
+v2_pods_metric_status_dict = v2_pods_metric_status_instance.to_dict()
+# create an instance of V2PodsMetricStatus from a dict
+v2_pods_metric_status_from_dict = V2PodsMetricStatus.from_dict(v2_pods_metric_status_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V2ResourceMetricSource.md

@@ -0,0 +1,30 @@
+# V2ResourceMetricSource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | [**V1ResourceName**](V1ResourceName.md) | name is the name of the resource in question. | [optional] 
+**target** | [**V2MetricTarget**](V2MetricTarget.md) | target specifies the target value for the given metric | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v2_resource_metric_source import V2ResourceMetricSource
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V2ResourceMetricSource from a JSON string
+v2_resource_metric_source_instance = V2ResourceMetricSource.from_json(json)
+# print the JSON string representation of the object
+print(V2ResourceMetricSource.to_json())
+
+# convert the object into a dict
+v2_resource_metric_source_dict = v2_resource_metric_source_instance.to_dict()
+# create an instance of V2ResourceMetricSource from a dict
+v2_resource_metric_source_from_dict = V2ResourceMetricSource.from_dict(v2_resource_metric_source_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+