com.google.api.services.compute.model

Class AutoscalingPolicyScalingSchedule

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.AutoscalingPolicyScalingSchedule

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AutoscalingPolicyScalingSchedule
extends GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AutoscalingPolicyScalingSchedule()

Method Summary

Modifier and Type	Method and Description
AutoscalingPolicyScalingSchedule	clone()
String	getDescription() A description of a scaling schedule.
Boolean	getDisabled() A boolean value that specifies whether a scaling schedule can influence autoscaler recommendations.
Integer	getDurationSec() The duration of time intervals, in seconds, for which this scaling schedule is to run.
Integer	getMinRequiredReplicas() The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule.
String	getSchedule() The start timestamps of time intervals when this scaling schedule is to provide a scaling signal.
String	getTimeZone() The time zone to use when interpreting the schedule.
AutoscalingPolicyScalingSchedule	set(String fieldName, Object value)
AutoscalingPolicyScalingSchedule	setDescription(String description) A description of a scaling schedule.
AutoscalingPolicyScalingSchedule	setDisabled(Boolean disabled) A boolean value that specifies whether a scaling schedule can influence autoscaler recommendations.
AutoscalingPolicyScalingSchedule	setDurationSec(Integer durationSec) The duration of time intervals, in seconds, for which this scaling schedule is to run.
AutoscalingPolicyScalingSchedule	setMinRequiredReplicas(Integer minRequiredReplicas) The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule.
AutoscalingPolicyScalingSchedule	setSchedule(String schedule) The start timestamps of time intervals when this scaling schedule is to provide a scaling signal.
AutoscalingPolicyScalingSchedule	setTimeZone(String timeZone) The time zone to use when interpreting the schedule.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

AutoscalingPolicyScalingSchedule

public AutoscalingPolicyScalingSchedule()

Method Detail

getDescription

public String getDescription()

A description of a scaling schedule.

Returns:

value or null for none

setDescription

public AutoscalingPolicyScalingSchedule setDescription(String description)

A description of a scaling schedule.

Parameters:

description - description or null for none

getDisabled

public Boolean getDisabled()

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:

value or null for none

setDisabled

public AutoscalingPolicyScalingSchedule setDisabled(Boolean disabled)

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.

Parameters:

disabled - disabled or null for none

getDurationSec

public Integer getDurationSec()

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:

value or null for none

setDurationSec

public AutoscalingPolicyScalingSchedule setDurationSec(Integer durationSec)

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.

Parameters:

durationSec - durationSec or null for none

getMinRequiredReplicas

public Integer getMinRequiredReplicas()

The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.

Returns:

value or null for none

setMinRequiredReplicas

public AutoscalingPolicyScalingSchedule setMinRequiredReplicas(Integer minRequiredReplicas)

The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.

Parameters:

minRequiredReplicas - minRequiredReplicas or null for none

getSchedule

public String getSchedule()

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:

value or null for none

setSchedule

public AutoscalingPolicyScalingSchedule setSchedule(String schedule)

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.

Parameters:

schedule - schedule or null for none

getTimeZone

public String getTimeZone()

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:

value or null for none

setTimeZone

public AutoscalingPolicyScalingSchedule setTimeZone(String timeZone)

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.

Parameters:

timeZone - timeZone or null for none

set

public AutoscalingPolicyScalingSchedule set(String fieldName,
                                            Object value)

Overrides:

set in class GenericJson

clone

public AutoscalingPolicyScalingSchedule clone()

Overrides:

clone in class GenericJson