Class AutoscalingPolicyScalingSchedule (1.45.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AutoscalingPolicyScalingSchedule

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER
Field Value
TypeDescription
int

DURATION_SEC_FIELD_NUMBER

public static final int DURATION_SEC_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_REQUIRED_REPLICAS_FIELD_NUMBER

public static final int MIN_REQUIRED_REPLICAS_FIELD_NUMBER
Field Value
TypeDescription
int

SCHEDULE_FIELD_NUMBER

public static final int SCHEDULE_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AutoscalingPolicyScalingSchedule getDefaultInstance()
Returns
TypeDescription
AutoscalingPolicyScalingSchedule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AutoscalingPolicyScalingSchedule.Builder newBuilder()
Returns
TypeDescription
AutoscalingPolicyScalingSchedule.Builder

newBuilder(AutoscalingPolicyScalingSchedule prototype)

public static AutoscalingPolicyScalingSchedule.Builder newBuilder(AutoscalingPolicyScalingSchedule prototype)
Parameter
NameDescription
prototypeAutoscalingPolicyScalingSchedule
Returns
TypeDescription
AutoscalingPolicyScalingSchedule.Builder

parseDelimitedFrom(InputStream input)

public static AutoscalingPolicyScalingSchedule parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicyScalingSchedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AutoscalingPolicyScalingSchedule parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicyScalingSchedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AutoscalingPolicyScalingSchedule parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicyScalingSchedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AutoscalingPolicyScalingSchedule parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicyScalingSchedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AutoscalingPolicyScalingSchedule parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicyScalingSchedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AutoscalingPolicyScalingSchedule parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AutoscalingPolicyScalingSchedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AutoscalingPolicyScalingSchedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AutoscalingPolicyScalingSchedule> parser()
Returns
TypeDescription
Parser<AutoscalingPolicyScalingSchedule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public AutoscalingPolicyScalingSchedule getDefaultInstanceForType()
Returns
TypeDescription
AutoscalingPolicyScalingSchedule

getDescription()

public String getDescription()

A description of a scaling schedule.

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A description of a scaling schedule.

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The minRequiredReplicas.

getParserForType()

public Parser<AutoscalingPolicyScalingSchedule> getParserForType()
Returns
TypeDescription
Parser<AutoscalingPolicyScalingSchedule>
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
TypeDescription
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
TypeDescription
ByteString

The bytes for schedule.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of "UTC" if left empty.

optional string time_zone = 36848094;

Returns
TypeDescription
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: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of "UTC" if left empty.

optional string time_zone = 36848094;

Returns
TypeDescription
ByteString

The bytes for timeZone.

hasDescription()

public boolean hasDescription()

A description of a scaling schedule.

optional string description = 422937596;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of "UTC" if left empty.

optional string time_zone = 36848094;

Returns
TypeDescription
boolean

Whether the timeZone field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AutoscalingPolicyScalingSchedule.Builder newBuilderForType()
Returns
TypeDescription
AutoscalingPolicyScalingSchedule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AutoscalingPolicyScalingSchedule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AutoscalingPolicyScalingSchedule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AutoscalingPolicyScalingSchedule.Builder toBuilder()
Returns
TypeDescription
AutoscalingPolicyScalingSchedule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException