Class Instance (2.3.4)

Version 2.3.4

• 2.49.0 (latest)
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.10
• 0.2.0

public final class Instance extends 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

Inheritance

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

Implements

InstanceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

APP_ENGINE_RELEASE_FIELD_NUMBER

public static final int APP_ENGINE_RELEASE_FIELD_NUMBER

Field Value

Type	Description
int

AVAILABILITY_FIELD_NUMBER

public static final int AVAILABILITY_FIELD_NUMBER

Field Value

Type	Description
int

AVERAGE_LATENCY_FIELD_NUMBER

public static final int AVERAGE_LATENCY_FIELD_NUMBER

Field Value

Type	Description
int

ERRORS_FIELD_NUMBER

public static final int ERRORS_FIELD_NUMBER

Field Value

Type	Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value

Type	Description
int

MEMORY_USAGE_FIELD_NUMBER

public static final int MEMORY_USAGE_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

QPS_FIELD_NUMBER

public static final int QPS_FIELD_NUMBER

Field Value

Type	Description
int

REQUESTS_FIELD_NUMBER

public static final int REQUESTS_FIELD_NUMBER

Field Value

Type	Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

Field Value

Type	Description
int

VM_DEBUG_ENABLED_FIELD_NUMBER

public static final int VM_DEBUG_ENABLED_FIELD_NUMBER

Field Value

Type	Description
int

VM_ID_FIELD_NUMBER

public static final int VM_ID_FIELD_NUMBER

Field Value

Type	Description
int

VM_IP_FIELD_NUMBER

public static final int VM_IP_FIELD_NUMBER

Field Value

Type	Description
int

VM_LIVENESS_FIELD_NUMBER

public static final int VM_LIVENESS_FIELD_NUMBER

Field Value

Type	Description
int

VM_NAME_FIELD_NUMBER

public static final int VM_NAME_FIELD_NUMBER

Field Value

Type	Description
int

VM_STATUS_FIELD_NUMBER

public static final int VM_STATUS_FIELD_NUMBER

Field Value

Type	Description
int

VM_ZONE_NAME_FIELD_NUMBER

public static final int VM_ZONE_NAME_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static Instance getDefaultInstance()

Returns

Type	Description
Instance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Instance.Builder newBuilder()

Returns

Type	Description
Instance.Builder

newBuilder(Instance prototype)

public static Instance.Builder newBuilder(Instance prototype)

Parameter

Name	Description
prototype	Instance

Returns

Type	Description
Instance.Builder

parseDelimitedFrom(InputStream input)

public static Instance parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Instance

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Instance

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Instance parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Instance

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Instance

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Instance parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Instance

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Instance

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Instance parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Instance

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Instance

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Instance parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Instance

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Instance

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Instance parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Instance

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Instance

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Instance> parser()

Returns

Type	Description
Parser<Instance>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

Returns

Type	Description
String	The appEngineRelease.

getAppEngineReleaseBytes()

public ByteString getAppEngineReleaseBytes()

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()

public Instance.Availability getAvailability()

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()

public int getAvailabilityValue()

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()

public int getAverageLatency()

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()

public Instance getDefaultInstanceForType()

Returns

Type	Description
Instance

getErrors()

public int getErrors()

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()

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

Returns

Type	Description
String	The id.

getIdBytes()

public ByteString getIdBytes()

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()

public long getMemoryUsage()

Output only. Total memory in use (bytes).

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

Returns

Type	Description
long	The memoryUsage.

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

Returns

Type	Description
String	The name.

getNameBytes()

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

Returns

Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<Instance> getParserForType()

Returns

Type	Description
Parser<Instance>

Overrides

GeneratedMessageV3.getParserForType()

getQps()

public float getQps()

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()

public int getRequests()

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()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getStartTime()

public Timestamp getStartTime()

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()

public TimestampOrBuilder getStartTimeOrBuilder()

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

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

Returns

Type	Description
TimestampOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

Returns

Type	Description
boolean	The vmDebugEnabled.

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

Returns

Type	Description
String	The vmId.

getVmIdBytes()

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

Returns

Type	Description
ByteString	The bytes for vmId.

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

Returns

Type	Description
String	The vmIp.

getVmIpBytes()

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

Returns

Type	Description
ByteString	The bytes for vmIp.

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

Returns

Type	Description
Instance.Liveness.LivenessState	The vmLiveness.

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

Returns

Type	Description
int	The enum numeric value on the wire for vmLiveness.

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

Returns

Type	Description
String	The vmName.

getVmNameBytes()

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

Returns

Type	Description
ByteString	The bytes for vmName.

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

Returns

Type	Description
String	The vmStatus.

getVmStatusBytes()

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

Returns

Type	Description
ByteString	The bytes for vmStatus.

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

Returns

Type	Description
String	The vmZoneName.

getVmZoneNameBytes()

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

Returns

Type	Description
ByteString	The bytes for vmZoneName.

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

Returns

Type	Description
boolean	Whether the startTime field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Instance.Builder newBuilderForType()

Returns

Type	Description
Instance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Instance.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Instance.Builder toBuilder()

Returns

Type	Description
Instance.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException