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

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

Methods

__construct

Constructor.

Parameters
Name	Description
`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
Type	Description
`string`

setName

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

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getId

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

Example: instance-1.

Returns
Type	Description
`string`

setId

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

Example: instance-1.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAppEngineRelease

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

Returns
Type	Description
`string`

setAppEngineRelease

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAvailability

Output only. Availability of the instance.

Returns
Type	Description
`int`

setAvailability

Output only. Availability of the instance.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getVmName

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

Returns
Type	Description
`string`

setVmName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVmZoneName

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

Returns
Type	Description
`string`

setVmZoneName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVmId

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

Returns
Type	Description
`string`

setVmId

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStartTime

Output only. Time that this instance was started.

@OutputOnly

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

Output only. Time that this instance was started.

@OutputOnly

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getRequests

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

Returns
Type	Description
`int`

setRequests

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getErrors

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

Returns
Type	Description
`int`

setErrors

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getQps

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

Returns
Type	Description
`float`

setQps

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

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getAverageLatency

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

Returns
Type	Description
`int`

setAverageLatency

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getMemoryUsage

Output only. Total memory in use (bytes).

Returns
Type	Description
`int\|string`

setMemoryUsage

Output only. Total memory in use (bytes).

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getVmStatus

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

Returns
Type	Description
`string`

setVmStatus

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVmDebugEnabled

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

Returns
Type	Description
`bool`

setVmDebugEnabled

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getVmIp

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

Returns
Type	Description
`string`

setVmIp

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVmLiveness

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

Returns
Type	Description
`int`

setVmLiveness

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`