Interface InstanceOrBuilder (2.31.0)

Version 2.31.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.52.0
• 2.49.0
• 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 interface InstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAppEngineRelease()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getErrors()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getQps()

public abstract 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 abstract 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.

getStartTime()

public abstract 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 abstract 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

getVmDebugEnabled()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.