Viewing file:  ProjectsLocationsBackupPlansBackups.php (9.55 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\BackupforGKE\Resource;
use Google\Service\BackupforGKE\Backup;
use Google\Service\BackupforGKE\GoogleLongrunningOperation;
use Google\Service\BackupforGKE\ListBackupsResponse;
use Google\Service\BackupforGKE\Policy;
use Google\Service\BackupforGKE\SetIamPolicyRequest;
use Google\Service\BackupforGKE\TestIamPermissionsRequest;
use Google\Service\BackupforGKE\TestIamPermissionsResponse;
/**
* The "backups" collection of methods.
* Typical usage is:
* <code>
* $gkebackupService = new Google\Service\BackupforGKE(...);
* $backups = $gkebackupService->projects_locations_backupPlans_backups;
* </code>
*/
class ProjectsLocationsBackupPlansBackups extends \Google\Service\Resource
{
/**
* Creates a Backup for the given BackupPlan. (backups.create)
*
* @param string $parent Required. The BackupPlan within which to create the
* Backup. Format: `projects/locations/backupPlans`
* @param Backup $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string backupId The client-provided short name for the Backup
* resource. This name must: - be between 1 and 63 characters long (inclusive) -
* consist of only lower-case ASCII letters, numbers, and dashes - start with a
* lower-case letter - end with a lower-case letter or number - be unique within
* the set of Backups in this BackupPlan
* @return GoogleLongrunningOperation
*/
public function create($parent, Backup $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], GoogleLongrunningOperation::class);
}
/**
* Deletes an existing Backup. (backups.delete)
*
* @param string $name Required. Name of the Backup resource. Format:
* `projects/locations/backupPlans/backups`
* @param array $optParams Optional parameters.
*
* @opt_param string etag If provided, this value must match the current value
* of the target Backup's etag field or the request is rejected.
* @opt_param bool force If set to true, any VolumeBackups below this Backup
* will also be deleted. Otherwise, the request will only succeed if the Backup
* has no VolumeBackups.
* @return GoogleLongrunningOperation
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], GoogleLongrunningOperation::class);
}
/**
* Retrieve the details of a single Backup. (backups.get)
*
* @param string $name Required. Full name of the Backup resource. Format:
* `projects/locations/backupPlans/backups`
* @param array $optParams Optional parameters.
* @return Backup
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Backup::class);
}
/**
* Gets the access control policy for a resource. Returns an empty policy if the
* resource exists and does not have a policy set. (backups.getIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param array $optParams Optional parameters.
*
* @opt_param int options.requestedPolicyVersion Optional. The maximum policy
* version that will be used to format the policy. Valid values are 0, 1, and 3.
* Requests specifying an invalid value will be rejected. Requests for policies
* with any conditional role bindings must specify version 3. Policies with no
* conditional role bindings may specify any valid value or leave the field
* unset. The policy in the response might use the policy version that you
* specified, or it might use a lower policy version. For example, if you
* specify version 3, but the policy has no conditional role bindings, the
* response uses version 1. To learn which resources support conditions in their
* IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
* @return Policy
*/
public function getIamPolicy($resource, $optParams = [])
{
$params = ['resource' => $resource];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Lists the Backups for a given BackupPlan.
* (backups.listProjectsLocationsBackupPlansBackups)
*
* @param string $parent Required. The BackupPlan that contains the Backups to
* list. Format: `projects/locations/backupPlans`
* @param array $optParams Optional parameters.
*
* @opt_param string filter Field match expression used to filter the results.
* @opt_param string orderBy Field by which to sort the results.
* @opt_param int pageSize The target number of results to return in a single
* response. If not specified, a default value will be chosen by the service.
* Note that the response may inclue a partial list and a caller should only
* rely on the response's next_page_token to determine if there are more
* instances left to be queried.
* @opt_param string pageToken The value of next_page_token received from a
* previous `ListBackups` call. Provide this to retrieve the subsequent page in
* a multi-page list of results. When paginating, all other parameters provided
* to `ListBackups` must match the call that provided the page token.
* @return ListBackupsResponse
*/
public function listProjectsLocationsBackupPlansBackups($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListBackupsResponse::class);
}
/**
* Update a Backup. (backups.patch)
*
* @param string $name Output only. The fully qualified name of the Backup.
* `projects/locations/backupPlans/backups`
* @param Backup $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask This is used to specify the fields to be
* overwritten in the Backup targeted for update. The values for each of these
* updated fields will be taken from the `backup_plan` provided with this
* request. Field names are relative to the root of the resource. If no
* `update_mask` is provided, all fields in `backup` will be written to the
* target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in
* `backup` are ignored and are not used to update the target Backup.
* @return GoogleLongrunningOperation
*/
public function patch($name, Backup $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], GoogleLongrunningOperation::class);
}
/**
* Sets the access control policy on the specified resource. Replaces any
* existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
* `PERMISSION_DENIED` errors. (backups.setIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* specified. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param SetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
*/
public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setIamPolicy', [$params], Policy::class);
}
/**
* 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. (backups.testIamPermissions)
*
* @param string $resource REQUIRED: The resource for which the policy detail is
* being requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param TestIamPermissionsRequest $postBody
* @param array $optParams Optional parameters.
* @return TestIamPermissionsResponse
*/
public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsBackupPlansBackups::class, 'Google_Service_BackupforGKE_Resource_ProjectsLocationsBackupPlansBackups');
|