Package com.google.cloud.compute.v1

Class Autoscaler

  • All Implemented Interfaces:
    AutoscalerOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Autoscaler
extends com.google.protobuf.GeneratedMessageV3
implements AutoscalerOrBuilder
     Represents an Autoscaler resource. Google Compute Engine has two Autoscaler resources: * [Zonal](/compute/docs/reference/rest/v1/autoscalers) * [Regional](/compute/docs/reference/rest/v1/regionAutoscalers) Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource.
    Protobuf type google.cloud.compute.v1.Autoscaler
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasAutoscalingPolicy

        public boolean hasAutoscalingPolicy()
         The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
        optional .google.cloud.compute.v1.AutoscalingPolicy autoscaling_policy = 221950041;
        Specified by:
        hasAutoscalingPolicy in interface AutoscalerOrBuilder
        Returns:
        Whether the autoscalingPolicy field is set.

      • getAutoscalingPolicy

        public AutoscalingPolicy getAutoscalingPolicy()
         The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
        optional .google.cloud.compute.v1.AutoscalingPolicy autoscaling_policy = 221950041;
        Specified by:
        getAutoscalingPolicy in interface AutoscalerOrBuilder
        Returns:
        The autoscalingPolicy.

      • getAutoscalingPolicyOrBuilder

        public AutoscalingPolicyOrBuilder getAutoscalingPolicyOrBuilder()
         The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.
        optional .google.cloud.compute.v1.AutoscalingPolicy autoscaling_policy = 221950041;
        Specified by:
        getAutoscalingPolicyOrBuilder in interface AutoscalerOrBuilder

      • hasCreationTimestamp

        public boolean hasCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
        optional string creation_timestamp = 30525366;
        Specified by:
        hasCreationTimestamp in interface AutoscalerOrBuilder
        Returns:
        Whether the creationTimestamp field is set.

      • getCreationTimestamp

        public String getCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestamp in interface AutoscalerOrBuilder
        Returns:
        The creationTimestamp.

      • getCreationTimestampBytes

        public com.google.protobuf.ByteString getCreationTimestampBytes()
         [Output Only] Creation timestamp in RFC3339 text format.
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestampBytes in interface AutoscalerOrBuilder
        Returns:
        The bytes for creationTimestamp.

      • hasDescription

        public boolean hasDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Specified by:
        hasDescription in interface AutoscalerOrBuilder
        Returns:
        Whether the description field is set.

      • getDescription

        public String getDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Specified by:
        getDescription in interface AutoscalerOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Specified by:
        getDescriptionBytes in interface AutoscalerOrBuilder
        Returns:
        The bytes for description.

      • hasId

        public boolean hasId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        optional uint64 id = 3355;
        Specified by:
        hasId in interface AutoscalerOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        optional uint64 id = 3355;
        Specified by:
        getId in interface AutoscalerOrBuilder
        Returns:
        The id.

      • hasKind

        public boolean hasKind()
         [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
        optional string kind = 3292052;
        Specified by:
        hasKind in interface AutoscalerOrBuilder
        Returns:
        Whether the kind field is set.

      • getKind

        public String getKind()
         [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
        optional string kind = 3292052;
        Specified by:
        getKind in interface AutoscalerOrBuilder
        Returns:
        The kind.

      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
        optional string kind = 3292052;
        Specified by:
        getKindBytes in interface AutoscalerOrBuilder
        Returns:
        The bytes for kind.

      • hasName

        public boolean hasName()
         Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string name = 3373707;
        Specified by:
        hasName in interface AutoscalerOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public String getName()
         Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string name = 3373707;
        Specified by:
        getName in interface AutoscalerOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        optional string name = 3373707;
        Specified by:
        getNameBytes in interface AutoscalerOrBuilder
        Returns:
        The bytes for name.

      • hasRecommendedSize

        public boolean hasRecommendedSize()
         [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction.
        optional int32 recommended_size = 257915749;
        Specified by:
        hasRecommendedSize in interface AutoscalerOrBuilder
        Returns:
        Whether the recommendedSize field is set.

      • getRecommendedSize

        public int getRecommendedSize()
         [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction.
        optional int32 recommended_size = 257915749;
        Specified by:
        getRecommendedSize in interface AutoscalerOrBuilder
        Returns:
        The recommendedSize.

      • hasRegion

        public boolean hasRegion()
         [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
        optional string region = 138946292;
        Specified by:
        hasRegion in interface AutoscalerOrBuilder
        Returns:
        Whether the region field is set.

      • getRegion

        public String getRegion()
         [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
        optional string region = 138946292;
        Specified by:
        getRegion in interface AutoscalerOrBuilder
        Returns:
        The region.

      • getRegionBytes

        public com.google.protobuf.ByteString getRegionBytes()
         [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
        optional string region = 138946292;
        Specified by:
        getRegionBytes in interface AutoscalerOrBuilder
        Returns:
        The bytes for region.

      • getScalingScheduleStatusCount

        public int getScalingScheduleStatusCount()
        Description copied from interface: AutoscalerOrBuilder
         [Output Only] Status information of existing scaling schedules.
        map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178;
        Specified by:
        getScalingScheduleStatusCount in interface AutoscalerOrBuilder

      • containsScalingScheduleStatus

        public boolean containsScalingScheduleStatus​(String key)
         [Output Only] Status information of existing scaling schedules.
        map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178;
        Specified by:
        containsScalingScheduleStatus in interface AutoscalerOrBuilder

      • hasSelfLink

        public boolean hasSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Specified by:
        hasSelfLink in interface AutoscalerOrBuilder
        Returns:
        Whether the selfLink field is set.

      • getSelfLink

        public String getSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Specified by:
        getSelfLink in interface AutoscalerOrBuilder
        Returns:
        The selfLink.

      • getSelfLinkBytes

        public com.google.protobuf.ByteString getSelfLinkBytes()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Specified by:
        getSelfLinkBytes in interface AutoscalerOrBuilder
        Returns:
        The bytes for selfLink.

      • hasStatus

        public boolean hasStatus()
         [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.
 Check the Status enum for the list of possible values.
        optional string status = 181260274;
        Specified by:
        hasStatus in interface AutoscalerOrBuilder
        Returns:
        Whether the status field is set.

      • getStatus

        public String getStatus()
         [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.
 Check the Status enum for the list of possible values.
        optional string status = 181260274;
        Specified by:
        getStatus in interface AutoscalerOrBuilder
        Returns:
        The status.

      • getStatusBytes

        public com.google.protobuf.ByteString getStatusBytes()
         [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.
 Check the Status enum for the list of possible values.
        optional string status = 181260274;
        Specified by:
        getStatusBytes in interface AutoscalerOrBuilder
        Returns:
        The bytes for status.

      • getStatusDetailsList

        public List<AutoscalerStatusDetails> getStatusDetailsList()
         [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
        repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845;
        Specified by:
        getStatusDetailsList in interface AutoscalerOrBuilder

      • getStatusDetailsOrBuilderList

        public List<? extends AutoscalerStatusDetailsOrBuilder> getStatusDetailsOrBuilderList()
         [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
        repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845;
        Specified by:
        getStatusDetailsOrBuilderList in interface AutoscalerOrBuilder

      • getStatusDetailsCount

        public int getStatusDetailsCount()
         [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
        repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845;
        Specified by:
        getStatusDetailsCount in interface AutoscalerOrBuilder

      • getStatusDetails

        public AutoscalerStatusDetails getStatusDetails​(int index)
         [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
        repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845;
        Specified by:
        getStatusDetails in interface AutoscalerOrBuilder

      • getStatusDetailsOrBuilder

        public AutoscalerStatusDetailsOrBuilder getStatusDetailsOrBuilder​(int index)
         [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
        repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845;
        Specified by:
        getStatusDetailsOrBuilder in interface AutoscalerOrBuilder

      • hasTarget

        public boolean hasTarget()
         URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.
        optional string target = 192835985;
        Specified by:
        hasTarget in interface AutoscalerOrBuilder
        Returns:
        Whether the target field is set.

      • getTarget

        public String getTarget()
         URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.
        optional string target = 192835985;
        Specified by:
        getTarget in interface AutoscalerOrBuilder
        Returns:
        The target.

      • getTargetBytes

        public com.google.protobuf.ByteString getTargetBytes()
         URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.
        optional string target = 192835985;
        Specified by:
        getTargetBytes in interface AutoscalerOrBuilder
        Returns:
        The bytes for target.

      • hasZone

        public boolean hasZone()
         [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
        optional string zone = 3744684;
        Specified by:
        hasZone in interface AutoscalerOrBuilder
        Returns:
        Whether the zone field is set.

      • getZone

        public String getZone()
         [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
        optional string zone = 3744684;
        Specified by:
        getZone in interface AutoscalerOrBuilder
        Returns:
        The zone.

      • getZoneBytes

        public com.google.protobuf.ByteString getZoneBytes()
         [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).
        optional string zone = 3744684;
        Specified by:
        getZoneBytes in interface AutoscalerOrBuilder
        Returns:
        The bytes for zone.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Autoscaler parseFrom​(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Autoscaler parseFrom​(ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Autoscaler parseFrom​(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Autoscaler parseFrom​(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Autoscaler parseFrom​(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Autoscaler parseFrom​(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Autoscaler parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Autoscaler.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Autoscaler.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Autoscaler.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Autoscaler getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Autoscaler> parser()

      • getParserForType

        public com.google.protobuf.Parser<Autoscaler> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Autoscaler getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder