Documentation

Google_Service_SystemsManagement_Resource_ProjectsPatchJobs extends Google_Service_Resource
in package

The "patchJobs" collection of methods.

Typical usage is: $osconfigService = new Google_Service_SystemsManagement(...); $patchJobs = $osconfigService->patchJobs;

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.
cancel()  : Google_Service_SystemsManagement_PatchJob
Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted. (patchJobs.cancel)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
execute()  : Google_Service_SystemsManagement_PatchJob
Patch VM instances by creating and running a patch job. (patchJobs.execute)
get()  : Google_Service_SystemsManagement_PatchJob
Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs. (patchJobs.get)
listProjectsPatchJobs()  : Google_Service_SystemsManagement_ListPatchJobsResponse
Get a list of patch jobs. (patchJobs.listProjectsPatchJobs)
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 —

cancel()

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted. (patchJobs.cancel)

public cancel(string $name, Google_Service_SystemsManagement_CancelPatchJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SystemsManagement_PatchJob
Parameters
$name : string

Required. Name of the patch in the form projects/patchJobs

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

Optional parameters.

Return values
Google_Service_SystemsManagement_PatchJob —

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

execute()

Patch VM instances by creating and running a patch job. (patchJobs.execute)

public execute(string $parent, Google_Service_SystemsManagement_ExecutePatchJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SystemsManagement_PatchJob
Parameters
$parent : string

Required. The project in which to run this patch in the form projects

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

Optional parameters.

Return values
Google_Service_SystemsManagement_PatchJob —

get()

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs. (patchJobs.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SystemsManagement_PatchJob
Parameters
$name : string

Required. Name of the patch in the form projects/patchJobs

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

Optional parameters.

Return values
Google_Service_SystemsManagement_PatchJob —

listProjectsPatchJobs()

Get a list of patch jobs. (patchJobs.listProjectsPatchJobs)

public listProjectsPatchJobs(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SystemsManagement_ListPatchJobsResponse
Parameters
$parent : string

Required. In the form of projects

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

Optional parameters.

Tags
opt_param

string pageToken A pagination token returned from a previous call that indicates where this listing should continue from.

opt_param

string filter If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.

opt_param

int pageSize The maximum number of instance status to return.

Return values
Google_Service_SystemsManagement_ListPatchJobsResponse —

convertToArrayAndStripNulls()

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

Search results