1. class
  2. Google
  3. \
  4. Service
  5. \
  6. OSConfig
  7. \
  8. Resource
  9. \
  10. ProjectsPatchDeployments

ProjectsPatchDeployments

class ProjectsPatchDeployments extends Resource (View source)

The "patchDeployments" collection of methods.

Typical usage is:

 $osconfigService = new Google\Service\OSConfig(...);
 $patchDeployments = $osconfigService->projects_patchDeployments;

Methods

PatchDeployment
create(string $parent, PatchDeployment $postBody, array $optParams = [])

Create an OS Config patch deployment. (patchDeployments.create)

OsconfigEmpty
delete(string $name, array $optParams = [])

Delete an OS Config patch deployment. (patchDeployments.delete)

PatchDeployment
get(string $name, array $optParams = [])

Get an OS Config patch deployment. (patchDeployments.get)

ListPatchDeploymentsResponse
listProjectsPatchDeployments(string $parent, array $optParams = [])

Get a page of OS Config patch deployments.

PatchDeployment
patch(string $name, PatchDeployment $postBody, array $optParams = [])

Update an OS Config patch deployment. (patchDeployments.patch)

PatchDeployment
pause(string $name, PausePatchDeploymentRequest $postBody, array $optParams = [])

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs. (patchDeployments.pause)

PatchDeployment
resume(string $name, ResumePatchDeploymentRequest $postBody, array $optParams = [])

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs. (patchDeployments.resume)

Details

at line 52
PatchDeployment create(string $parent, PatchDeployment $postBody, array $optParams = [])

Create an OS Config patch deployment. (patchDeployments.create)

Parameters

string $parent

Required. The project to apply this patch deployment to in the form projects.
PatchDeployment $postBody
array $optParams

Optional parameters.

Return Value

PatchDeployment

Exceptions

Exception

at line 67
OsconfigEmpty delete(string $name, array $optParams = [])

Delete an OS Config patch deployment. (patchDeployments.delete)

Parameters

string $name

Required. The resource name of the patch deployment in the form projects/patchDeployments.
array $optParams

Optional parameters.

Return Value

OsconfigEmpty

Exceptions

Exception

at line 82
PatchDeployment get(string $name, array $optParams = [])

Get an OS Config patch deployment. (patchDeployments.get)

Parameters

string $name

Required. The resource name of the patch deployment in the form projects/patchDeployments.
array $optParams

Optional parameters.

Return Value

PatchDeployment

Exceptions

Exception

at line 104
ListPatchDeploymentsResponse listProjectsPatchDeployments(string $parent, array $optParams = [])

Get a page of OS Config patch deployments.

(patchDeployments.listProjectsPatchDeployments)

Parameters

string $parent

Required. The resource name of the parent in the form projects.
array $optParams

Optional parameters.

Return Value

ListPatchDeploymentsResponse

Exceptions

Exception

at line 125
PatchDeployment patch(string $name, PatchDeployment $postBody, array $optParams = [])

Update an OS Config patch deployment. (patchDeployments.patch)

Parameters

string $name

Unique name for the patch deployment resource in a project. The patch deployment name is in the form: projects/{project_id}/patchDeployments/{patch_deployment_id}. This field is ignored when you create a new patch deployment.
PatchDeployment $postBody
array $optParams

Optional parameters.

Return Value

PatchDeployment

Exceptions

Exception

at line 142
PatchDeployment pause(string $name, PausePatchDeploymentRequest $postBody, array $optParams = [])

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs. (patchDeployments.pause)

Parameters

string $name

Required. The resource name of the patch deployment in the form projects/patchDeployments.
PausePatchDeploymentRequest $postBody
array $optParams

Optional parameters.

Return Value

PatchDeployment

Exceptions

Exception

at line 159
PatchDeployment resume(string $name, ResumePatchDeploymentRequest $postBody, array $optParams = [])

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs. (patchDeployments.resume)

Parameters

string $name

Required. The resource name of the patch deployment in the form projects/patchDeployments.
ResumePatchDeploymentRequest $postBody
array $optParams

Optional parameters.

Return Value

PatchDeployment

Exceptions

Exception