ThresholdBasedAutoScalingPolicyDetails

class oci.data_science.models.ThresholdBasedAutoScalingPolicyDetails(**kwargs)

Bases: oci.data_science.models.auto_scaling_policy_details.AutoScalingPolicyDetails

Details for a threshold-based autoscaling policy to enable on the model deployment. In a threshold-based autoscaling policy, an autoscaling action is triggered when a performance metric meets or exceeds a threshold.

Attributes

AUTO_SCALING_POLICY_TYPE_THRESHOLD str(object=’’) -> str
auto_scaling_policy_type [Required] Gets the auto_scaling_policy_type of this AutoScalingPolicyDetails.
initial_instance_count [Required] Gets the initial_instance_count of this ThresholdBasedAutoScalingPolicyDetails.
maximum_instance_count [Required] Gets the maximum_instance_count of this ThresholdBasedAutoScalingPolicyDetails.
minimum_instance_count [Required] Gets the minimum_instance_count of this ThresholdBasedAutoScalingPolicyDetails.
rules [Required] Gets the rules of this ThresholdBasedAutoScalingPolicyDetails.

Methods

__init__(**kwargs) Initializes a new ThresholdBasedAutoScalingPolicyDetails object with values from keyword arguments.
get_subtype(object_dictionary) Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
AUTO_SCALING_POLICY_TYPE_THRESHOLD = 'THRESHOLD'
__init__(**kwargs)

Initializes a new ThresholdBasedAutoScalingPolicyDetails object with values from keyword arguments. The default value of the auto_scaling_policy_type attribute of this class is THRESHOLD and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • auto_scaling_policy_type (str) – The value to assign to the auto_scaling_policy_type property of this ThresholdBasedAutoScalingPolicyDetails. Allowed values for this property are: “THRESHOLD”
  • rules (list[oci.data_science.models.MetricExpressionRule]) – The value to assign to the rules property of this ThresholdBasedAutoScalingPolicyDetails.
  • maximum_instance_count (int) – The value to assign to the maximum_instance_count property of this ThresholdBasedAutoScalingPolicyDetails.
  • minimum_instance_count (int) – The value to assign to the minimum_instance_count property of this ThresholdBasedAutoScalingPolicyDetails.
  • initial_instance_count (int) – The value to assign to the initial_instance_count property of this ThresholdBasedAutoScalingPolicyDetails.
auto_scaling_policy_type

[Required] Gets the auto_scaling_policy_type of this AutoScalingPolicyDetails. The type of autoscaling policy.

Allowed values for this property are: “THRESHOLD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The auto_scaling_policy_type of this AutoScalingPolicyDetails.
Return type:str
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

initial_instance_count

[Required] Gets the initial_instance_count of this ThresholdBasedAutoScalingPolicyDetails. For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the model deployment immediately after autoscaling is enabled. Note that anytime this value is updated, the number of instances will be reset to this value. After autoscaling retrieves performance metrics, the number of instances is automatically adjusted from this initial number to a number that is based on the limits that you set.

Returns:The initial_instance_count of this ThresholdBasedAutoScalingPolicyDetails.
Return type:int
maximum_instance_count

[Required] Gets the maximum_instance_count of this ThresholdBasedAutoScalingPolicyDetails. For a threshold-based autoscaling policy, this value is the maximum number of instances the model deployment is allowed to increase to (scale out).

Returns:The maximum_instance_count of this ThresholdBasedAutoScalingPolicyDetails.
Return type:int
minimum_instance_count

[Required] Gets the minimum_instance_count of this ThresholdBasedAutoScalingPolicyDetails. For a threshold-based autoscaling policy, this value is the minimum number of instances the model deployment is allowed to decrease to (scale in).

Returns:The minimum_instance_count of this ThresholdBasedAutoScalingPolicyDetails.
Return type:int
rules

[Required] Gets the rules of this ThresholdBasedAutoScalingPolicyDetails. The list of autoscaling policy rules.

Returns:The rules of this ThresholdBasedAutoScalingPolicyDetails.
Return type:list[oci.data_science.models.MetricExpressionRule]