com.google.api.services.appengine.v1.model

Class Instance

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.appengine.v1.model.Instance

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Instance
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the App Engine Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Instance()

Method Summary

Modifier and Type	Method and Description
Instance	clone()
String	getAppEngineRelease() Output only.
String	getAvailability() Output only.
Integer	getAverageLatency() Output only.
Integer	getErrors() Output only.
String	getId() Output only.
Long	getMemoryUsage() Output only.
String	getName() Output only.
Float	getQps() Output only.
Integer	getRequests() Output only.
String	getStartTime() Output only.
Boolean	getVmDebugEnabled() Output only.
String	getVmId() Output only.
String	getVmIp() Output only.
String	getVmLiveness() Output only.
String	getVmName() Output only.
String	getVmStatus() Output only.
String	getVmZoneName() Output only.
Instance	set(String fieldName, Object value)
Instance	setAppEngineRelease(String appEngineRelease) Output only.
Instance	setAvailability(String availability) Output only.
Instance	setAverageLatency(Integer averageLatency) Output only.
Instance	setErrors(Integer errors) Output only.
Instance	setId(String id) Output only.
Instance	setMemoryUsage(Long memoryUsage) Output only.
Instance	setName(String name) Output only.
Instance	setQps(Float qps) Output only.
Instance	setRequests(Integer requests) Output only.
Instance	setStartTime(String startTime) Output only.
Instance	setVmDebugEnabled(Boolean vmDebugEnabled) Output only.
Instance	setVmId(String vmId) Output only.
Instance	setVmIp(String vmIp) Output only.
Instance	setVmLiveness(String vmLiveness) Output only.
Instance	setVmName(String vmName) Output only.
Instance	setVmStatus(String vmStatus) Output only.
Instance	setVmZoneName(String vmZoneName) Output only.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Instance

public Instance()

Method Detail

getAppEngineRelease

public String getAppEngineRelease()

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

Returns:

value or null for none

setAppEngineRelease

public Instance setAppEngineRelease(String appEngineRelease)

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

Parameters:

appEngineRelease - appEngineRelease or null for none

getAvailability

public String getAvailability()

Output only. Availability of the instance.

Returns:

value or null for none

setAvailability

public Instance setAvailability(String availability)

Output only. Availability of the instance.

Parameters:

availability - availability or null for none

getAverageLatency

public Integer getAverageLatency()

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

Returns:

value or null for none

setAverageLatency

public Instance setAverageLatency(Integer averageLatency)

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

Parameters:

averageLatency - averageLatency or null for none

getErrors

public Integer getErrors()

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

Returns:

value or null for none

setErrors

public Instance setErrors(Integer errors)

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

Parameters:

errors - errors or null for none

getId

public String getId()

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

Returns:

value or null for none

setId

public Instance setId(String id)

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

Parameters:

id - id or null for none

getMemoryUsage

public Long getMemoryUsage()

Output only. Total memory in use (bytes).

Returns:

value or null for none

setMemoryUsage

public Instance setMemoryUsage(Long memoryUsage)

Output only. Total memory in use (bytes).

Parameters:

memoryUsage - memoryUsage or null for none

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.

Returns:

value or null for none

setName

public Instance setName(String name)

Output only. Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.

Parameters:

name - name or null for none

getQps

public Float getQps()

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

Returns:

value or null for none

setQps

public Instance setQps(Float qps)

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

Parameters:

qps - qps or null for none

getRequests

public Integer getRequests()

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

Returns:

value or null for none

setRequests

public Instance setRequests(Integer requests)

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

Parameters:

requests - requests or null for none

getStartTime

public String getStartTime()

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

Returns:

value or null for none

setStartTime

public Instance setStartTime(String startTime)

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

Parameters:

startTime - startTime or null for none

getVmDebugEnabled

public Boolean getVmDebugEnabled()

Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.

Returns:

value or null for none

setVmDebugEnabled

public Instance setVmDebugEnabled(Boolean vmDebugEnabled)

Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.

Parameters:

vmDebugEnabled - vmDebugEnabled or null for none

getVmId

public String getVmId()

Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.

Returns:

value or null for none

setVmId

public Instance setVmId(String vmId)

Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.

Parameters:

vmId - vmId or null for none

getVmIp

public String getVmIp()

Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment.

Returns:

value or null for none

setVmIp

public Instance setVmIp(String vmIp)

Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment.

Parameters:

vmIp - vmIp or null for none

getVmLiveness

public String getVmLiveness()

Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.

Returns:

value or null for none

setVmLiveness

public Instance setVmLiveness(String vmLiveness)

Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.

Parameters:

vmLiveness - vmLiveness or null for none

getVmName

public String getVmName()

Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.

Returns:

value or null for none

setVmName

public Instance setVmName(String vmName)

Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.

Parameters:

vmName - vmName or null for none

getVmStatus

public String getVmStatus()

Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.

Returns:

value or null for none

setVmStatus

public Instance setVmStatus(String vmStatus)

Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.

Parameters:

vmStatus - vmStatus or null for none

getVmZoneName

public String getVmZoneName()

Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.

Returns:

value or null for none

setVmZoneName

public Instance setVmZoneName(String vmZoneName)

Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.

Parameters:

vmZoneName - vmZoneName or null for none

set

public Instance set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Instance clone()

Overrides:

clone in class com.google.api.client.json.GenericJson