public final class AutoscalingPolicyScalingSchedule extends GeneratedMessageV3 implements AutoscalingPolicyScalingScheduleOrBuilder
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.
Protobuf type google.cloud.compute.v1.AutoscalingPolicyScalingSchedule
Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISABLED_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER
Field Value
DURATION_SEC_FIELD_NUMBER
public static final int DURATION_SEC_FIELD_NUMBER
Field Value
MIN_REQUIRED_REPLICAS_FIELD_NUMBER
public static final int MIN_REQUIRED_REPLICAS_FIELD_NUMBER
Field Value
SCHEDULE_FIELD_NUMBER
public static final int SCHEDULE_FIELD_NUMBER
Field Value
TIME_ZONE_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static AutoscalingPolicyScalingSchedule getDefaultInstance()
Returns
getDefaultInstanceForType()
public AutoscalingPolicyScalingSchedule getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
A description of a scaling schedule.
optional string description = 422937596;
Returns
Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
A description of a scaling schedule.
optional string description = 422937596;
Returns
Type | Description |
ByteString | The bytes for description.
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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.
optional bool disabled = 270940796;
Returns
Type | Description |
boolean | The disabled.
|
getDurationSec()
public int 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.
optional int32 duration_sec = 212356902;
Returns
Type | Description |
int | The durationSec.
|
getMinRequiredReplicas()
public int getMinRequiredReplicas()
The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.
optional int32 min_required_replicas = 365514414;
Returns
Type | Description |
int | The minRequiredReplicas.
|
getParserForType()
public Parser<AutoscalingPolicyScalingSchedule> getParserForType()
Returns
Overrides
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.
optional string schedule = 375820951;
Returns
Type | Description |
String | The schedule.
|
getScheduleBytes()
public ByteString getScheduleBytes()
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.
optional string schedule = 375820951;
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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 \u201cUTC\u201d if left empty.
optional string time_zone = 36848094;
Returns
Type | Description |
String | The timeZone.
|
getTimeZoneBytes()
public ByteString getTimeZoneBytes()
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 \u201cUTC\u201d if left empty.
optional string time_zone = 36848094;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasDescription()
public boolean hasDescription()
A description of a scaling schedule.
optional string description = 422937596;
Returns
Type | Description |
boolean | Whether the description field is set.
|
hasDisabled()
public boolean hasDisabled()
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.
optional bool disabled = 270940796;
Returns
Type | Description |
boolean | Whether the disabled field is set.
|
hasDurationSec()
public boolean hasDurationSec()
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.
optional int32 duration_sec = 212356902;
Returns
Type | Description |
boolean | Whether the durationSec field is set.
|
hasMinRequiredReplicas()
public boolean hasMinRequiredReplicas()
The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.
optional int32 min_required_replicas = 365514414;
Returns
Type | Description |
boolean | Whether the minRequiredReplicas field is set.
|
hasSchedule()
public boolean hasSchedule()
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.
optional string schedule = 375820951;
Returns
Type | Description |
boolean | Whether the schedule field is set.
|
hasTimeZone()
public boolean hasTimeZone()
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 \u201cUTC\u201d if left empty.
optional string time_zone = 36848094;
Returns
Type | Description |
boolean | Whether the timeZone field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static AutoscalingPolicyScalingSchedule.Builder newBuilder()
Returns
newBuilder(AutoscalingPolicyScalingSchedule prototype)
public static AutoscalingPolicyScalingSchedule.Builder newBuilder(AutoscalingPolicyScalingSchedule prototype)
Parameter
Returns
newBuilderForType()
public AutoscalingPolicyScalingSchedule.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AutoscalingPolicyScalingSchedule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static AutoscalingPolicyScalingSchedule parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AutoscalingPolicyScalingSchedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AutoscalingPolicyScalingSchedule parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AutoscalingPolicyScalingSchedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AutoscalingPolicyScalingSchedule parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AutoscalingPolicyScalingSchedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AutoscalingPolicyScalingSchedule parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AutoscalingPolicyScalingSchedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AutoscalingPolicyScalingSchedule parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AutoscalingPolicyScalingSchedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AutoscalingPolicyScalingSchedule parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AutoscalingPolicyScalingSchedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AutoscalingPolicyScalingSchedule> parser()
Returns
toBuilder()
public AutoscalingPolicyScalingSchedule.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions