class AppsServicesVersionsInstances extends Resource (View source)

The "instances" collection of methods.

Typical usage is:

 $appengineService = new Google\Service\Appengine(...);
 $instances = $appengineService->apps_services_versions_instances;

Methods

debug(string $appsId, string $servicesId, string $versionsId, string $instancesId, DebugInstanceRequest $postBody, array $optParams = [])

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment. (instances.debug)

delete(string $appsId, string $servicesId, string $versionsId, string $instancesId, array $optParams = [])

Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are- managed) | flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are- managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin- api/reference/rest/v1/apps.services.versions/patch) method.

get(string $appsId, string $servicesId, string $versionsId, string $instancesId, array $optParams = [])

Gets instance information. (instances.get)

listAppsServicesVersionsInstances(string $appsId, string $servicesId, string $versionsId, array $optParams = [])

Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monit oring/api/ref_v3/rest/v3/projects.timeSeries/list).

Details

Operation debug(string $appsId, string $servicesId, string $versionsId, string $instancesId, DebugInstanceRequest $postBody, array $optParams = [])

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment. (instances.debug)

Parameters

string $appsId

Part of name. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.

string $servicesId

Part of name. See documentation of appsId.

string $versionsId

Part of name. See documentation of appsId.

string $instancesId

Part of name. See documentation of appsId.

DebugInstanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation delete(string $appsId, string $servicesId, string $versionsId, string $instancesId, array $optParams = [])

Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are- managed) | flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are- managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin- api/reference/rest/v1/apps.services.versions/patch) method.

(instances.delete)

Parameters

string $appsId

Part of name. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.

string $servicesId

Part of name. See documentation of appsId.

string $versionsId

Part of name. See documentation of appsId.

string $instancesId

Part of name. See documentation of appsId.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Instance get(string $appsId, string $servicesId, string $versionsId, string $instancesId, array $optParams = [])

Gets instance information. (instances.get)

Parameters

string $appsId

Part of name. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.

string $servicesId

Part of name. See documentation of appsId.

string $versionsId

Part of name. See documentation of appsId.

string $instancesId

Part of name. See documentation of appsId.

array $optParams

Optional parameters.

Return Value

Instance

Exceptions

Exception

ListInstancesResponse listAppsServicesVersionsInstances(string $appsId, string $servicesId, string $versionsId, array $optParams = [])

Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monit oring/api/ref_v3/rest/v3/projects.timeSeries/list).

(instances.listAppsServicesVersionsInstances)

Parameters

string $appsId

Part of parent. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.

string $servicesId

Part of parent. See documentation of appsId.

string $versionsId

Part of parent. See documentation of appsId.

array $optParams

Optional parameters.

Return Value

ListInstancesResponse

Exceptions

Exception