Google Cloud Appengine Admin V1 Client - Class Instance (1.2.2)

Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class Instance.

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

Generated from protobuf message google.appengine.v1.Instance

Namespace

Google \ Cloud \ AppEngine \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ id string

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

↳ app_engine_release string

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

↳ availability int

Output only. Availability of the instance.

↳ vm_name string

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

↳ vm_zone_name string

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

↳ vm_id string

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

↳ start_time Google\Protobuf\Timestamp

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

↳ requests int

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

↳ errors int

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

↳ qps float

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

↳ average_latency int

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

↳ memory_usage int|string

Output only. Total memory in use (bytes).

↳ vm_status string

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

↳ vm_debug_enabled bool

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

↳ vm_ip string

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

↳ vm_liveness int

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

getName

Output only. Full path to the Instance resource in the API.

Example: apps/myapp/services/default/versions/v1/instances/instance-1.

Returns
TypeDescription
string

setName

Output only. Full path to the Instance resource in the API.

Example: apps/myapp/services/default/versions/v1/instances/instance-1.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

Output only. Relative name of the instance within the version.

Example: instance-1.

Returns
TypeDescription
string

setId

Output only. Relative name of the instance within the version.

Example: instance-1.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAppEngineRelease

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

Returns
TypeDescription
string

setAppEngineRelease

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAvailability

Output only. Availability of the instance.

Returns
TypeDescription
int

setAvailability

Output only. Availability of the instance.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getVmName

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

Returns
TypeDescription
string

setVmName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVmZoneName

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

Returns
TypeDescription
string

setVmZoneName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVmId

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

Returns
TypeDescription
string

setVmId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStartTime

Output only. Time that this instance was started.

@OutputOnly

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. Time that this instance was started.

@OutputOnly

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getRequests

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

Returns
TypeDescription
int

setRequests

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getErrors

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

Returns
TypeDescription
int

setErrors

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getQps

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

Returns
TypeDescription
float

setQps

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

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getAverageLatency

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

Returns
TypeDescription
int

setAverageLatency

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMemoryUsage

Output only. Total memory in use (bytes).

Returns
TypeDescription
int|string

setMemoryUsage

Output only. Total memory in use (bytes).

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getVmStatus

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

Returns
TypeDescription
string

setVmStatus

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVmDebugEnabled

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

Returns
TypeDescription
bool

setVmDebugEnabled

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getVmIp

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

Returns
TypeDescription
string

setVmIp

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVmLiveness

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

Returns
TypeDescription
int

setVmLiveness

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this