Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::AutoscalingPolicyScalingSchedule.
Scaling based on user-defined schedule. The message describes a single scaling schedule. A scaling schedule changes the minimum number of VM instances an autoscaler can recommend, which can trigger scaling out.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#description
def description() -> ::String
Returns
- (::String) — A description of a scaling schedule.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — A description of a scaling schedule.
Returns
- (::String) — A description of a scaling schedule.
#disabled
def disabled() -> ::Boolean
Returns
- (::Boolean) — A boolean value that specifies whether a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect. This field is optional, and its value is false by default.
#disabled=
def disabled=(value) -> ::Boolean
Parameter
- value (::Boolean) — A boolean value that specifies whether a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect. This field is optional, and its value is false by default.
Returns
- (::Boolean) — A boolean value that specifies whether a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect. This field is optional, and its value is false by default.
#duration_sec
def duration_sec() -> ::Integer
Returns
- (::Integer) — The duration of time intervals, in seconds, for which this scaling schedule is to run. The minimum allowed value is 300. This field is required.
#duration_sec=
def duration_sec=(value) -> ::Integer
Parameter
- value (::Integer) — The duration of time intervals, in seconds, for which this scaling schedule is to run. The minimum allowed value is 300. This field is required.
Returns
- (::Integer) — The duration of time intervals, in seconds, for which this scaling schedule is to run. The minimum allowed value is 300. This field is required.
#min_required_replicas
def min_required_replicas() -> ::Integer
Returns
- (::Integer) — The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.
#min_required_replicas=
def min_required_replicas=(value) -> ::Integer
Parameter
- value (::Integer) — The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.
Returns
- (::Integer) — The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.
#schedule
def schedule() -> ::String
Returns
- (::String) — The start timestamps of time intervals when this scaling schedule is to provide a scaling signal. This field uses the extended cron format (with an optional year field). The expression can describe a single timestamp if the optional year is set, in which case the scaling schedule runs once. The schedule is interpreted with respect to time_zone. This field is required. Note: These timestamps only describe when autoscaler starts providing the scaling signal. The VMs need additional time to become serving.
#schedule=
def schedule=(value) -> ::String
Parameter
- value (::String) — The start timestamps of time intervals when this scaling schedule is to provide a scaling signal. This field uses the extended cron format (with an optional year field). The expression can describe a single timestamp if the optional year is set, in which case the scaling schedule runs once. The schedule is interpreted with respect to time_zone. This field is required. Note: These timestamps only describe when autoscaler starts providing the scaling signal. The VMs need additional time to become serving.
Returns
- (::String) — The start timestamps of time intervals when this scaling schedule is to provide a scaling signal. This field uses the extended cron format (with an optional year field). The expression can describe a single timestamp if the optional year is set, in which case the scaling schedule runs once. The schedule is interpreted with respect to time_zone. This field is required. Note: These timestamps only describe when autoscaler starts providing the scaling signal. The VMs need additional time to become serving.
#time_zone
def time_zone() -> ::String
Returns
- (::String) — The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of ���UTC��� if left empty.
#time_zone=
def time_zone=(value) -> ::String
Parameter
- value (::String) — The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of ���UTC��� if left empty.
Returns
- (::String) — The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of ���UTC��� if left empty.