class ProjectsLocationsRestorePlans extends Resource (View source)

The "restorePlans" collection of methods.

Typical usage is:

 $gkebackupService = new Google\Service\BackupforGKE(...);
 $restorePlans = $gkebackupService->projects_locations_restorePlans;

Methods

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

Creates a new RestorePlan in a given location. (restorePlans.create)

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

Deletes an existing RestorePlan. (restorePlans.delete)

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

Retrieve the details of a single RestorePlan. (restorePlans.get)

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (restorePlans.getIamPolicy)

listProjectsLocationsRestorePlans(string $parent, array $optParams = [])

Lists RestorePlans in a given location.

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

Update a RestorePlan. (restorePlans.patch)

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (restorePlans.setIamPolicy)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

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

Creates a new RestorePlan in a given location. (restorePlans.create)

Parameters

string $parent

Required. The location within which to create the RestorePlan. Format: projects/locations

RestorePlan $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Deletes an existing RestorePlan. (restorePlans.delete)

Parameters

string $name

Required. Fully qualified RestorePlan name. Format: projects/locations/restorePlans

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Retrieve the details of a single RestorePlan. (restorePlans.get)

Parameters

string $name

Required. Fully qualified RestorePlan name. Format: projects/locations/restorePlans

array $optParams

Optional parameters.

Return Value

RestorePlan

Exceptions

Exception

Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (restorePlans.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

ListRestorePlansResponse listProjectsLocationsRestorePlans(string $parent, array $optParams = [])

Lists RestorePlans in a given location.

(restorePlans.listProjectsLocationsRestorePlans)

Parameters

string $parent

Required. The location that contains the RestorePlans to list. Format: projects/locations

array $optParams

Optional parameters.

Return Value

ListRestorePlansResponse

Exceptions

Exception

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

Update a RestorePlan. (restorePlans.patch)

Parameters

string $name

Output only. The full name of the RestorePlan resource. Format: projects/locations/restorePlans.

RestorePlan $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (restorePlans.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (restorePlans.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception