Documentation

Google_Service_Appengine_Resource_AppsServices extends Google_Service_Resource
in package

The "services" collection of methods.

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

Table of Contents

$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.
delete()  : Google_Service_Appengine_Operation
Deletes the specified service and all enclosed versions. (services.delete)
get()  : Google_Service_Appengine_Service
Gets the current configuration of the specified service. (services.get)
listAppsServices()  : Google_Service_Appengine_ListServicesResponse
Lists all the services in the application. (services.listAppsServices)
patch()  : Google_Service_Appengine_Operation
Updates the configuration of the specified service. (services.patch)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
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>
Tags
static
Return values
string

$requestUrl

delete()

Deletes the specified service and all enclosed versions. (services.delete)

public delete(string $appsId, string $servicesId[, 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.

$servicesId : string

Part of name. See documentation of appsId.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Appengine_Operation

get()

Gets the current configuration of the specified service. (services.get)

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

Part of name. Name of the resource requested. Example: apps/myapp/services/default.

$servicesId : string

Part of name. See documentation of appsId.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Appengine_Service

listAppsServices()

Lists all the services in the application. (services.listAppsServices)

public listAppsServices(string $appsId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_ListServicesResponse
Parameters
$appsId : string

Part of parent. Name of the parent Application resource. Example: apps/myapp.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken Continuation token for fetching the next page of results.

opt_param

int pageSize Maximum results to return per page.

Return values
Google_Service_Appengine_ListServicesResponse

patch()

Updates the configuration of the specified service. (services.patch)

public patch(string $appsId, string $servicesId, Google_Service_Appengine_Service $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_Operation
Parameters
$appsId : string

Part of name. Name of the resource to update. Example: apps/myapp/services/default.

$servicesId : string

Part of name. See documentation of appsId.

$postBody : Google_Service_Appengine_Service
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool migrateTraffic Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin- api/reference/rest/v1/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin- api/reference/rest/v1/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin- api/reference/rest/v1/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting- traffic).

opt_param

string updateMask Standard field mask for the set of fields to be updated.

Return values
Google_Service_Appengine_Operation

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results