MetricBasedHorizontalScalingPolicyDetails

class oci.bds.models.MetricBasedHorizontalScalingPolicyDetails(**kwargs)

Bases: AutoScalePolicyDetails

Details of a metric based horizontal autoscaling policy.

In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

Attributes:

ACTION_TYPE_HORIZONTAL_SCALING

A constant which can be used with the action_type property of a AutoScalePolicyDetails.

ACTION_TYPE_VERTICAL_SCALING

A constant which can be used with the action_type property of a AutoScalePolicyDetails.

POLICY_TYPE_METRIC_BASED_HORIZONTAL_SCALING_POLICY

A constant which can be used with the policy_type property of a AutoScalePolicyDetails.

POLICY_TYPE_METRIC_BASED_VERTICAL_SCALING_POLICY

A constant which can be used with the policy_type property of a AutoScalePolicyDetails.

POLICY_TYPE_SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY

A constant which can be used with the policy_type property of a AutoScalePolicyDetails.

POLICY_TYPE_SCHEDULE_BASED_VERTICAL_SCALING_POLICY

A constant which can be used with the policy_type property of a AutoScalePolicyDetails.

TRIGGER_TYPE_METRIC_BASED

A constant which can be used with the trigger_type property of a AutoScalePolicyDetails.

TRIGGER_TYPE_SCHEDULE_BASED

A constant which can be used with the trigger_type property of a AutoScalePolicyDetails.

action_type

[Required] Gets the action_type of this AutoScalePolicyDetails.

policy_type

[Required] Gets the policy_type of this AutoScalePolicyDetails.

scale_in_config

Gets the scale_in_config of this MetricBasedHorizontalScalingPolicyDetails.

scale_out_config

Gets the scale_out_config of this MetricBasedHorizontalScalingPolicyDetails.

trigger_type

[Required] Gets the trigger_type of this AutoScalePolicyDetails.

Methods:

__init__(**kwargs)

Initializes a new MetricBasedHorizontalScalingPolicyDetails 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.

ACTION_TYPE_HORIZONTAL_SCALING = 'HORIZONTAL_SCALING'

A constant which can be used with the action_type property of a AutoScalePolicyDetails. This constant has a value of “HORIZONTAL_SCALING”

ACTION_TYPE_VERTICAL_SCALING = 'VERTICAL_SCALING'

A constant which can be used with the action_type property of a AutoScalePolicyDetails. This constant has a value of “VERTICAL_SCALING”

POLICY_TYPE_METRIC_BASED_HORIZONTAL_SCALING_POLICY = 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'

A constant which can be used with the policy_type property of a AutoScalePolicyDetails. This constant has a value of “METRIC_BASED_HORIZONTAL_SCALING_POLICY”

POLICY_TYPE_METRIC_BASED_VERTICAL_SCALING_POLICY = 'METRIC_BASED_VERTICAL_SCALING_POLICY'

A constant which can be used with the policy_type property of a AutoScalePolicyDetails. This constant has a value of “METRIC_BASED_VERTICAL_SCALING_POLICY”

POLICY_TYPE_SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY = 'SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY'

A constant which can be used with the policy_type property of a AutoScalePolicyDetails. This constant has a value of “SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY”

POLICY_TYPE_SCHEDULE_BASED_VERTICAL_SCALING_POLICY = 'SCHEDULE_BASED_VERTICAL_SCALING_POLICY'

A constant which can be used with the policy_type property of a AutoScalePolicyDetails. This constant has a value of “SCHEDULE_BASED_VERTICAL_SCALING_POLICY”

TRIGGER_TYPE_METRIC_BASED = 'METRIC_BASED'

A constant which can be used with the trigger_type property of a AutoScalePolicyDetails. This constant has a value of “METRIC_BASED”

TRIGGER_TYPE_SCHEDULE_BASED = 'SCHEDULE_BASED'

A constant which can be used with the trigger_type property of a AutoScalePolicyDetails. This constant has a value of “SCHEDULE_BASED”

__init__(**kwargs)

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

Parameters
  • policy_type (str) – The value to assign to the policy_type property of this MetricBasedHorizontalScalingPolicyDetails. Allowed values for this property are: “METRIC_BASED_VERTICAL_SCALING_POLICY”, “METRIC_BASED_HORIZONTAL_SCALING_POLICY”, “SCHEDULE_BASED_VERTICAL_SCALING_POLICY”, “SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY”

  • trigger_type (str) – The value to assign to the trigger_type property of this MetricBasedHorizontalScalingPolicyDetails. Allowed values for this property are: “METRIC_BASED”, “SCHEDULE_BASED”

  • action_type (str) – The value to assign to the action_type property of this MetricBasedHorizontalScalingPolicyDetails. Allowed values for this property are: “VERTICAL_SCALING”, “HORIZONTAL_SCALING”

  • scale_out_config (oci.bds.models.MetricBasedHorizontalScaleOutConfig) – The value to assign to the scale_out_config property of this MetricBasedHorizontalScalingPolicyDetails.

  • scale_in_config (oci.bds.models.MetricBasedHorizontalScaleInConfig) – The value to assign to the scale_in_config property of this MetricBasedHorizontalScalingPolicyDetails.

property action_type

[Required] Gets the action_type of this AutoScalePolicyDetails. The type of autoscaling action to take.

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

Returns

The action_type of this AutoScalePolicyDetails.

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.

property policy_type

[Required] Gets the policy_type of this AutoScalePolicyDetails. Type of autoscaling policy.

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

Returns

The policy_type of this AutoScalePolicyDetails.

Return type

str

property scale_in_config

Gets the scale_in_config of this MetricBasedHorizontalScalingPolicyDetails.

Returns

The scale_in_config of this MetricBasedHorizontalScalingPolicyDetails.

Return type

oci.bds.models.MetricBasedHorizontalScaleInConfig

property scale_out_config

Gets the scale_out_config of this MetricBasedHorizontalScalingPolicyDetails.

Returns

The scale_out_config of this MetricBasedHorizontalScalingPolicyDetails.

Return type

oci.bds.models.MetricBasedHorizontalScaleOutConfig

property trigger_type

[Required] Gets the trigger_type of this AutoScalePolicyDetails. The type of autoscaling trigger.

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

Returns

The trigger_type of this AutoScalePolicyDetails.

Return type

str