Documentation

Google_Service_Appengine_Resource_AppsServicesVersionsInstances extends Google_Service_Resource
in package

Application

The "instances" collection of methods.

Typical usage is: $appengineService = new Google_Service_Appengine(...); $instances = $appengineService->instances;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
debug() : Google_Service_Appengine_Operation: 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() : Google_Service_Appengine_Operation: 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() : Google_Service_Appengine_Instance: Gets instance information. (instances.get)
listAppsServicesVersionsInstances() : Google_Service_Appengine_ListInstancesResponse: 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).
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

debug()

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)


    public
                debug(string $appsId, string $servicesId, string $versionsId, string $instancesId, Google_Service_Appengine_DebugInstanceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_Operation

Parameters

$appsId : string: Part of name. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
$servicesId : string: Part of name. See documentation of appsId.
$versionsId : string: Part of name. See documentation of appsId.
$instancesId : string: Part of name. See documentation of appsId.
$postBody : Google_Service_Appengine_DebugInstanceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Appengine_Operation —

delete()

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.


    public
                delete(string $appsId, string $servicesId, string $versionsId, string $instancesId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_Operation

(instances.delete)

Parameters

$appsId : string: Part of name. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
$servicesId : string: Part of name. See documentation of appsId.
$versionsId : string: Part of name. See documentation of appsId.
$instancesId : string: Part of name. See documentation of appsId.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Appengine_Operation —

get()

Gets instance information. (instances.get)


    public
                get(string $appsId, string $servicesId, string $versionsId, string $instancesId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_Instance

Parameters

$appsId : string: Part of name. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
$servicesId : string: Part of name. See documentation of appsId.
$versionsId : string: Part of name. See documentation of appsId.
$instancesId : string: Part of name. See documentation of appsId.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Appengine_Instance —

listAppsServicesVersionsInstances()

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).


    public
                listAppsServicesVersionsInstances(string $appsId, string $servicesId, string $versionsId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_ListInstancesResponse

(instances.listAppsServicesVersionsInstances)

Parameters

$appsId : string: Part of parent. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.
$servicesId : string: Part of parent. See documentation of appsId.
$versionsId : string: Part of parent. See documentation of appsId.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Appengine_ListInstancesResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —

Documentation

Google_Service_Appengine_Resource_AppsServicesVersionsInstances extends Google_Service_Resource
in package

Application

Table of Contents

Properties

$client

$methods

$resourceName

$rootUrl

$serviceName

$servicePath

$stackParameters

Methods

__construct()

Parameters

Return values

call()

Parameters

Tags

Return values

createRequestUri()

Parameters

Tags

Return values

debug()

Parameters

Return values

delete()

Parameters

Return values

get()

Parameters

Return values

listAppsServicesVersionsInstances()

Parameters

Tags

Return values

convertToArrayAndStripNulls()

Parameters

Return values

Search results