* $gkebackupService = new Google\Service\BackupforGKE(...); * $backupPlans = $gkebackupService->projects_locations_backupPlans; * */ class ProjectsLocationsBackupPlans extends \Google\Service\Resource { /** * Creates a new BackupPlan in a given location. (backupPlans.create) * * @param string $parent Required. The location within which to create the * BackupPlan. Format: `projects/locations` * @param BackupPlan $postBody * @param array $optParams Optional parameters. * * @opt_param string backupPlanId Required. The client-provided short name for * the BackupPlan 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 BackupPlans in this location * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function create($parent, BackupPlan $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GoogleLongrunningOperation::class); } /** * Deletes an existing BackupPlan. (backupPlans.delete) * * @param string $name Required. Fully qualified BackupPlan name. Format: * `projects/locations/backupPlans` * @param array $optParams Optional parameters. * * @opt_param string etag Optional. If provided, this value must match the * current value of the target BackupPlan's etag field or the request is * rejected. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ 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 BackupPlan. (backupPlans.get) * * @param string $name Required. Fully qualified BackupPlan name. Format: * `projects/locations/backupPlans` * @param array $optParams Optional parameters. * @return BackupPlan * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], BackupPlan::class); } /** * Gets the access control policy for a resource. Returns an empty policy if the * resource exists and does not have a policy set. (backupPlans.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 * @throws \Google\Service\Exception */ public function getIamPolicy($resource, $optParams = []) { $params = ['resource' => $resource]; $params = array_merge($params, $optParams); return $this->call('getIamPolicy', [$params], Policy::class); } /** * Lists BackupPlans in a given location. * (backupPlans.listProjectsLocationsBackupPlans) * * @param string $parent Required. The location that contains the BackupPlans to * list. Format: `projects/locations` * @param array $optParams Optional parameters. * * @opt_param string filter Optional. Field match expression used to filter the * results. * @opt_param string orderBy Optional. Field by which to sort the results. * @opt_param int pageSize Optional. 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 include 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 Optional. The value of next_page_token received * from a previous `ListBackupPlans` call. Provide this to retrieve the * subsequent page in a multi-page list of results. When paginating, all other * parameters provided to `ListBackupPlans` must match the call that provided * the page token. * @return ListBackupPlansResponse * @throws \Google\Service\Exception */ public function listProjectsLocationsBackupPlans($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListBackupPlansResponse::class); } /** * Update a BackupPlan. (backupPlans.patch) * * @param string $name Output only. The full name of the BackupPlan resource. * Format: `projects/locations/backupPlans` * @param BackupPlan $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask Optional. This is used to specify the fields to * be overwritten in the BackupPlan 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 (e.g., * `description`, `backup_config.include_volume_data`, etc.) If no `update_mask` * is provided, all fields in `backup_plan` will be written to the target * BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in * `backup_plan` are ignored and are not used to update the target BackupPlan. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function patch($name, BackupPlan $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. (backupPlans.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 * @throws \Google\Service\Exception */ 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. * (backupPlans.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 * @throws \Google\Service\Exception */ 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(ProjectsLocationsBackupPlans::class, 'Google_Service_BackupforGKE_Resource_ProjectsLocationsBackupPlans');