Class Instance (2.5.0)

publicfinalclass InstanceextendsGeneratedMessageV3implementsInstanceOrBuilder

An Instance resource is the computing unit that App Engine uses to automatically scale an application.

Protobuf type google.appengine.v1.Instance

Implements

InstanceOrBuilder

Inherited Members

Static Fields

APP_ENGINE_RELEASE_FIELD_NUMBER

publicstaticfinalintAPP_ENGINE_RELEASE_FIELD_NUMBER
Field Value
Type Description
int

AVAILABILITY_FIELD_NUMBER

publicstaticfinalintAVAILABILITY_FIELD_NUMBER
Field Value
Type Description
int

AVERAGE_LATENCY_FIELD_NUMBER

publicstaticfinalintAVERAGE_LATENCY_FIELD_NUMBER
Field Value
Type Description
int

ERRORS_FIELD_NUMBER

publicstaticfinalintERRORS_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

publicstaticfinalintID_FIELD_NUMBER
Field Value
Type Description
int

MEMORY_USAGE_FIELD_NUMBER

publicstaticfinalintMEMORY_USAGE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER
Field Value
Type Description
int

QPS_FIELD_NUMBER

publicstaticfinalintQPS_FIELD_NUMBER
Field Value
Type Description
int

REQUESTS_FIELD_NUMBER

publicstaticfinalintREQUESTS_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

publicstaticfinalintSTART_TIME_FIELD_NUMBER
Field Value
Type Description
int

VM_DEBUG_ENABLED_FIELD_NUMBER

publicstaticfinalintVM_DEBUG_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

VM_ID_FIELD_NUMBER

publicstaticfinalintVM_ID_FIELD_NUMBER
Field Value
Type Description
int

VM_IP_FIELD_NUMBER

publicstaticfinalintVM_IP_FIELD_NUMBER
Field Value
Type Description
int

VM_LIVENESS_FIELD_NUMBER

publicstaticfinalintVM_LIVENESS_FIELD_NUMBER
Field Value
Type Description
int

VM_NAME_FIELD_NUMBER

publicstaticfinalintVM_NAME_FIELD_NUMBER
Field Value
Type Description
int

VM_STATUS_FIELD_NUMBER

publicstaticfinalintVM_STATUS_FIELD_NUMBER
Field Value
Type Description
int

VM_ZONE_NAME_FIELD_NUMBER

publicstaticfinalintVM_ZONE_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticInstancegetDefaultInstance()
Returns
Type Description

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description

newBuilder()

publicstaticInstance.BuildernewBuilder()
Returns
Type Description

newBuilder(Instance prototype)

publicstaticInstance.BuildernewBuilder(Instanceprototype)
Parameter
Name Description
prototype Instance
Returns
Type Description

parseDelimitedFrom(InputStream input)

publicstaticInstanceparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Exceptions
Type Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(byte[] data)

publicstaticInstanceparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
Exceptions
Type Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteString data)

publicstaticInstanceparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(CodedInputStream input)

publicstaticInstanceparseFrom(CodedInputStreaminput)
Parameter
Name Description
Returns
Type Description
Exceptions
Type Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(InputStream input)

publicstaticInstanceparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Exceptions
Type Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteBuffer data)

publicstaticInstanceparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticInstanceparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parser()

publicstaticParser<Instance>parser()
Returns
Type Description

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
Overrides

getAppEngineRelease()

publicStringgetAppEngineRelease()

Output only. App Engine release this instance is running on.

string app_engine_release = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The appEngineRelease.

getAppEngineReleaseBytes()

publicByteStringgetAppEngineReleaseBytes()

Output only. App Engine release this instance is running on.

string app_engine_release = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for appEngineRelease.

getAvailability()

publicInstance.AvailabilitygetAvailability()

Output only. Availability of the instance.

.google.appengine.v1.Instance.Availability availability = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Availability

The availability.

getAvailabilityValue()

publicintgetAvailabilityValue()

Output only. Availability of the instance.

.google.appengine.v1.Instance.Availability availability = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for availability.

getAverageLatency()

publicintgetAverageLatency()

Output only. Average latency (ms) over the last minute.

int32 average_latency = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The averageLatency.

getDefaultInstanceForType()

publicInstancegetDefaultInstanceForType()
Returns
Type Description

getErrors()

publicintgetErrors()

Output only. Number of errors since this instance was started.

int32 errors = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The errors.

getId()

publicStringgetId()

Output only. Relative name of the instance within the version. Example: instance-1.

string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The id.

getIdBytes()

publicByteStringgetIdBytes()

Output only. Relative name of the instance within the version. Example: instance-1.

string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for id.

getMemoryUsage()

publiclonggetMemoryUsage()

Output only. Total memory in use (bytes).

int64 memory_usage = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The memoryUsage.

getName()

publicStringgetName()

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];

Returns
Type Description
String

The name.

getNameBytes()

publicByteStringgetNameBytes()

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];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

publicParser<Instance>getParserForType()
Returns
Type Description
Overrides

getQps()

publicfloatgetQps()

Output only. Average queries per second (QPS) over the last minute.

float qps = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The qps.

getRequests()

publicintgetRequests()

Output only. Number of requests since this instance was started.

int32 requests = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The requests.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

publicTimestampgetStartTime()

Output only. Time that this instance was started. @OutputOnly

.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

publicTimestampOrBuildergetStartTimeOrBuilder()

Output only. Time that this instance was started. @OutputOnly

.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description

getUnknownFields()

publicfinalUnknownFieldSetgetUnknownFields()
Returns
Type Description
Overrides

getVmDebugEnabled()

publicbooleangetVmDebugEnabled()

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];

Returns
Type Description
boolean

The vmDebugEnabled.

getVmId()

publicStringgetVmId()

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];

Returns
Type Description
String

The vmId.

getVmIdBytes()

publicByteStringgetVmIdBytes()

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];

Returns
Type Description
ByteString

The bytes for vmId.

getVmIp()

publicStringgetVmIp()

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];

Returns
Type Description
String

The vmIp.

getVmIpBytes()

publicByteStringgetVmIpBytes()

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];

Returns
Type Description
ByteString

The bytes for vmIp.

getVmLiveness()

publicInstance.Liveness.LivenessStategetVmLiveness()

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];

Returns
Type Description

getVmLivenessValue()

publicintgetVmLivenessValue()

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];

Returns
Type Description
int

The enum numeric value on the wire for vmLiveness.

getVmName()

publicStringgetVmName()

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];

Returns
Type Description
String

The vmName.

getVmNameBytes()

publicByteStringgetVmNameBytes()

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];

Returns
Type Description
ByteString

The bytes for vmName.

getVmStatus()

publicStringgetVmStatus()

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];

Returns
Type Description
String

The vmStatus.

getVmStatusBytes()

publicByteStringgetVmStatusBytes()

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];

Returns
Type Description
ByteString

The bytes for vmStatus.

getVmZoneName()

publicStringgetVmZoneName()

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];

Returns
Type Description
String

The vmZoneName.

getVmZoneNameBytes()

publicByteStringgetVmZoneNameBytes()

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];

Returns
Type Description
ByteString

The bytes for vmZoneName.

hasStartTime()

publicbooleanhasStartTime()

Output only. Time that this instance was started. @OutputOnly

.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
Overrides

newBuilderForType()

publicInstance.BuildernewBuilderForType()
Returns
Type Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedInstance.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
Returns
Type Description
Overrides

toBuilder()

publicInstance.BuildertoBuilder()
Returns
Type Description

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
Overrides Exceptions
Type Description

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.