ScheduleBasedHorizontalScalingPolicyDetails

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

Bases: AutoScalePolicyDetails

Details of a schedule based horizontal autoscaling policy.

In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

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.

schedule_details

Gets the schedule_details of this ScheduleBasedHorizontalScalingPolicyDetails.

timezone

Gets the timezone of this ScheduleBasedHorizontalScalingPolicyDetails.

trigger_type

[Required] Gets the trigger_type of this AutoScalePolicyDetails.

Methods:

__init__(**kwargs)

Initializes a new ScheduleBasedHorizontalScalingPolicyDetails 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 ScheduleBasedHorizontalScalingPolicyDetails object with values from keyword arguments. The default value of the policy_type attribute of this class is SCHEDULE_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 ScheduleBasedHorizontalScalingPolicyDetails. 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 ScheduleBasedHorizontalScalingPolicyDetails. Allowed values for this property are: “METRIC_BASED”, “SCHEDULE_BASED”

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

  • timezone (str) – The value to assign to the timezone property of this ScheduleBasedHorizontalScalingPolicyDetails.

  • schedule_details (list[oci.bds.models.HorizontalScalingScheduleDetails]) – The value to assign to the schedule_details property of this ScheduleBasedHorizontalScalingPolicyDetails.

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 schedule_details

Gets the schedule_details of this ScheduleBasedHorizontalScalingPolicyDetails. Details of a horizontal scaling schedule.

Returns

The schedule_details of this ScheduleBasedHorizontalScalingPolicyDetails.

Return type

list[oci.bds.models.HorizontalScalingScheduleDetails]

property timezone

Gets the timezone of this ScheduleBasedHorizontalScalingPolicyDetails. The time zone of the execution schedule, in IANA time zone database name format

Returns

The timezone of this ScheduleBasedHorizontalScalingPolicyDetails.

Return type

str

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