Class Instance (2.3.4)

Stay organized with collections Save and categorize content based on your preferences.
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

Implements

InstanceOrBuilder

Static Fields

APP_ENGINE_RELEASE_FIELD_NUMBER

public static final int APP_ENGINE_RELEASE_FIELD_NUMBER
Field Value
TypeDescription
int

AVAILABILITY_FIELD_NUMBER

public static final int AVAILABILITY_FIELD_NUMBER
Field Value
TypeDescription
int

AVERAGE_LATENCY_FIELD_NUMBER

public static final int AVERAGE_LATENCY_FIELD_NUMBER
Field Value
TypeDescription
int

ERRORS_FIELD_NUMBER

public static final int ERRORS_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

MEMORY_USAGE_FIELD_NUMBER

public static final int MEMORY_USAGE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

QPS_FIELD_NUMBER

public static final int QPS_FIELD_NUMBER
Field Value
TypeDescription
int

REQUESTS_FIELD_NUMBER

public static final int REQUESTS_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

VM_DEBUG_ENABLED_FIELD_NUMBER

public static final int VM_DEBUG_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

VM_ID_FIELD_NUMBER

public static final int VM_ID_FIELD_NUMBER
Field Value
TypeDescription
int

VM_IP_FIELD_NUMBER

public static final int VM_IP_FIELD_NUMBER
Field Value
TypeDescription
int

VM_LIVENESS_FIELD_NUMBER

public static final int VM_LIVENESS_FIELD_NUMBER
Field Value
TypeDescription
int

VM_NAME_FIELD_NUMBER

public static final int VM_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

VM_STATUS_FIELD_NUMBER

public static final int VM_STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

VM_ZONE_NAME_FIELD_NUMBER

public static final int VM_ZONE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Instance getDefaultInstance()
Returns
TypeDescription
Instance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Instance.Builder newBuilder()
Returns
TypeDescription
Instance.Builder

newBuilder(Instance prototype)

public static Instance.Builder newBuilder(Instance prototype)
Parameter
NameDescription
prototypeInstance
Returns
TypeDescription
Instance.Builder

parseDelimitedFrom(InputStream input)

public static Instance parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Instance parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Instance parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Instance parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Instance parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Instance parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Instance> parser()
Returns
TypeDescription
Parser<Instance>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The averageLatency.

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Instance> getParserForType()
Returns
TypeDescription
Parser<Instance>
Overrides

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
TypeDescription
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
TypeDescription
int

The requests.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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];

Returns
TypeDescription
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
TypeDescription
TimestampOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Instance.Builder newBuilderForType()
Returns
TypeDescription
Instance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Instance.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Instance.Builder toBuilder()
Returns
TypeDescription
Instance.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException