Package com.google.appengine.v1

Class Instance

  • All Implemented Interfaces:
    InstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Instance
extends com.google.protobuf.GeneratedMessageV3
implements InstanceOrBuilder
     An Instance resource is the computing unit that App Engine uses to
 automatically scale an application.
    Protobuf type google.appengine.v1.Instance
    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()

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Output only. Full path to the Instance resource in the API.
 Example: `apps/myapp/services/default/versions/v1/instances/instance-1`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface InstanceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Full path to the Instance resource in the API.
 Example: `apps/myapp/services/default/versions/v1/instances/instance-1`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for name.

      • getId

        public String getId()
         Output only. Relative name of the instance within the version.
 Example: `instance-1`.
        string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface InstanceOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Output only. Relative name of the instance within the version.
 Example: `instance-1`.
        string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIdBytes in interface InstanceOrBuilder
        Returns:
        The bytes for id.

      • getAppEngineRelease

        public String getAppEngineRelease()
         Output only. App Engine release this instance is running on.
        string app_engine_release = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAppEngineRelease in interface InstanceOrBuilder
        Returns:
        The appEngineRelease.

      • getAppEngineReleaseBytes

        public com.google.protobuf.ByteString getAppEngineReleaseBytes()
         Output only. App Engine release this instance is running on.
        string app_engine_release = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAppEngineReleaseBytes in interface InstanceOrBuilder
        Returns:
        The bytes for appEngineRelease.

      • getAvailabilityValue

        public int getAvailabilityValue()
         Output only. Availability of the instance.
        .google.appengine.v1.Instance.Availability availability = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAvailabilityValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for availability.

      • getAvailability

        public Instance.Availability getAvailability()
         Output only. Availability of the instance.
        .google.appengine.v1.Instance.Availability availability = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAvailability in interface InstanceOrBuilder
        Returns:
        The availability.

      • getVmName

        public String getVmName()
         Output only. Name of the virtual machine where this instance lives. Only applicable
 for instances in App Engine flexible environment.
        string vm_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmName in interface InstanceOrBuilder
        Returns:
        The vmName.

      • getVmNameBytes

        public com.google.protobuf.ByteString getVmNameBytes()
         Output only. Name of the virtual machine where this instance lives. Only applicable
 for instances in App Engine flexible environment.
        string vm_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for vmName.

      • getVmZoneName

        public String getVmZoneName()
         Output only. Zone where the virtual machine is located. Only applicable for instances
 in App Engine flexible environment.
        string vm_zone_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmZoneName in interface InstanceOrBuilder
        Returns:
        The vmZoneName.

      • getVmZoneNameBytes

        public com.google.protobuf.ByteString getVmZoneNameBytes()
         Output only. Zone where the virtual machine is located. Only applicable for instances
 in App Engine flexible environment.
        string vm_zone_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmZoneNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for vmZoneName.

      • getVmId

        public String getVmId()
         Output only. Virtual machine ID of this instance. Only applicable for instances in
 App Engine flexible environment.
        string vm_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmId in interface InstanceOrBuilder
        Returns:
        The vmId.

      • getVmIdBytes

        public com.google.protobuf.ByteString getVmIdBytes()
         Output only. Virtual machine ID of this instance. Only applicable for instances in
 App Engine flexible environment.
        string vm_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmIdBytes in interface InstanceOrBuilder
        Returns:
        The bytes for vmId.

      • hasStartTime

        public boolean hasStartTime()
         Output only. Time that this instance was started.

 @OutputOnly
        .google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStartTime in interface InstanceOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Output only. Time that this instance was started.

 @OutputOnly
        .google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTime in interface InstanceOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. Time that this instance was started.

 @OutputOnly
        .google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTimeOrBuilder in interface InstanceOrBuilder

      • getRequests

        public int getRequests()
         Output only. Number of requests since this instance was started.
        int32 requests = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getRequests in interface InstanceOrBuilder
        Returns:
        The requests.

      • getErrors

        public int getErrors()
         Output only. Number of errors since this instance was started.
        int32 errors = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getErrors in interface InstanceOrBuilder
        Returns:
        The errors.

      • getQps

        public float getQps()
         Output only. Average queries per second (QPS) over the last minute.
        float qps = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getQps in interface InstanceOrBuilder
        Returns:
        The qps.

      • getAverageLatency

        public int getAverageLatency()
         Output only. Average latency (ms) over the last minute.
        int32 average_latency = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAverageLatency in interface InstanceOrBuilder
        Returns:
        The averageLatency.

      • getMemoryUsage

        public long getMemoryUsage()
         Output only. Total memory in use (bytes).
        int64 memory_usage = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMemoryUsage in interface InstanceOrBuilder
        Returns:
        The memoryUsage.

      • getVmStatus

        public String getVmStatus()
         Output only. Status of the virtual machine where this instance lives. Only applicable
 for instances in App Engine flexible environment.
        string vm_status = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmStatus in interface InstanceOrBuilder
        Returns:
        The vmStatus.

      • getVmStatusBytes

        public com.google.protobuf.ByteString getVmStatusBytes()
         Output only. Status of the virtual machine where this instance lives. Only applicable
 for instances in App Engine flexible environment.
        string vm_status = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmStatusBytes in interface InstanceOrBuilder
        Returns:
        The bytes for vmStatus.

      • getVmDebugEnabled

        public boolean getVmDebugEnabled()
         Output only. Whether this instance is in debug mode. Only applicable for instances in
 App Engine flexible environment.
        bool vm_debug_enabled = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmDebugEnabled in interface InstanceOrBuilder
        Returns:
        The vmDebugEnabled.

      • getVmIp

        public String getVmIp()
         Output only. The IP address of this instance. Only applicable for instances in App
 Engine flexible environment.
        string vm_ip = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmIp in interface InstanceOrBuilder
        Returns:
        The vmIp.

      • getVmIpBytes

        public com.google.protobuf.ByteString getVmIpBytes()
         Output only. The IP address of this instance. Only applicable for instances in App
 Engine flexible environment.
        string vm_ip = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmIpBytes in interface InstanceOrBuilder
        Returns:
        The bytes for vmIp.

      • getVmLivenessValue

        public int getVmLivenessValue()
         Output only. The liveness health check of this instance. Only applicable for instances
 in App Engine flexible environment.
        .google.appengine.v1.Instance.Liveness.LivenessState vm_liveness = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmLivenessValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for vmLiveness.

      • getVmLiveness

        public Instance.Liveness.LivenessState getVmLiveness()
         Output only. The liveness health check of this instance. Only applicable for instances
 in App Engine flexible environment.
        .google.appengine.v1.Instance.Liveness.LivenessState vm_liveness = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getVmLiveness in interface InstanceOrBuilder
        Returns:
        The vmLiveness.

      • 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 Instance parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Instance getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Instance> 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 Instance getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder