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
Static Fields
APP_ENGINE_RELEASE_FIELD_NUMBER
public static final int APP_ENGINE_RELEASE_FIELD_NUMBER
Field Value
AVAILABILITY_FIELD_NUMBER
public static final int AVAILABILITY_FIELD_NUMBER
Field Value
AVERAGE_LATENCY_FIELD_NUMBER
public static final int AVERAGE_LATENCY_FIELD_NUMBER
Field Value
ERRORS_FIELD_NUMBER
public static final int ERRORS_FIELD_NUMBER
Field Value
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
MEMORY_USAGE_FIELD_NUMBER
public static final int MEMORY_USAGE_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
QPS_FIELD_NUMBER
public static final int QPS_FIELD_NUMBER
Field Value
REQUESTS_FIELD_NUMBER
public static final int REQUESTS_FIELD_NUMBER
Field Value
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
Field Value
VM_DEBUG_ENABLED_FIELD_NUMBER
public static final int VM_DEBUG_ENABLED_FIELD_NUMBER
Field Value
VM_ID_FIELD_NUMBER
public static final int VM_ID_FIELD_NUMBER
Field Value
VM_IP_FIELD_NUMBER
public static final int VM_IP_FIELD_NUMBER
Field Value
VM_LIVENESS_FIELD_NUMBER
public static final int VM_LIVENESS_FIELD_NUMBER
Field Value
VM_NAME_FIELD_NUMBER
public static final int VM_NAME_FIELD_NUMBER
Field Value
VM_STATUS_FIELD_NUMBER
public static final int VM_STATUS_FIELD_NUMBER
Field Value
VM_ZONE_NAME_FIELD_NUMBER
public static final int VM_ZONE_NAME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Instance getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Instance.Builder newBuilder()
Returns
newBuilder(Instance prototype)
public static Instance.Builder newBuilder(Instance prototype)
Parameter
Returns
public static Instance parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Instance parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Instance parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Instance parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Instance parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Instance parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Instance> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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];
| 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];
| 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];
getAvailabilityValue()
public int getAvailabilityValue()
Output only. Availability of the instance.
.google.appengine.v1.Instance.Availability availability = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
| Type | Description |
| int | The averageLatency.
|
getDefaultInstanceForType()
public Instance getDefaultInstanceForType()
Returns
getErrors()
Output only. Number of errors since this instance was started.
int32 errors = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The errors.
|
getId()
Output only. Relative name of the instance within the version.
Example: instance-1.
string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
getMemoryUsage()
public long getMemoryUsage()
Output only. Total memory in use (bytes).
int64 memory_usage = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| long | The memoryUsage.
|
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];
| 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];
getParserForType()
public Parser<Instance> getParserForType()
Returns
Overrides
getQps()
Output only. Average queries per second (QPS) over the last minute.
float qps = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| float | The qps.
|
getRequests()
Output only. Number of requests since this instance was started.
int32 requests = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The requests.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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];
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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
| Type | Description |
| boolean | The vmDebugEnabled.
|
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];
| 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];
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];
| 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];
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];
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];
| 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];
| 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];
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];
| 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];
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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the startTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Instance.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Instance.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
