* $spannerService = new Google\Service\Spanner(...); * $backupOperations = $spannerService->projects_instances_backupOperations; * */ class ProjectsInstancesBackupOperations extends \Google\Service\Resource { /** * Lists the backup long-running operations in the given instance. A backup * operation has a name of the form `projects//instances//backups//operations/`. * The long-running operation metadata field type `metadata.type_url` describes * the type of the metadata. Operations returned include those that have * completed/failed/canceled within the last 7 days, and pending operations. * Operations returned are ordered by * `operation.metadata.value.progress.start_time` in descending order starting * from the most recently started operation. * (backupOperations.listProjectsInstancesBackupOperations) * * @param string $parent Required. The instance of the backup operations. Values * are of the form `projects//instances/`. * @param array $optParams Optional parameters. * * @opt_param string filter An expression that filters the list of returned * backup operations. A filter expression consists of a field name, a comparison * operator, and a value for filtering. The value must be a string, a number, or * a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, * `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not * case sensitive. The following fields in the operation are eligible for * filtering: * `name` - The name of the long-running operation * `done` - False * if the operation is in progress, else true. * `metadata.@type` - the type of * metadata. For example, the type string for CreateBackupMetadata is * `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. * * `metadata.` - any field in metadata.value. `metadata.@type` must be * specified first if filtering on metadata fields. * `error` - Error associated * with the long-running operation. * `response.@type` - the type of response. * * `response.` - any field in response.value. You can combine multiple * expressions by enclosing each expression in parentheses. By default, * expressions are combined with AND logic, but you can specify AND, OR, and NOT * logic explicitly. Here are a few examples: * `done:true` - The operation is * complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.databas * e.v1.CreateBackupMetadata) AND` \ `metadata.database:prod` - Returns * operations where: * The operation's metadata type is CreateBackupMetadata. * * The source database name of backup contains the string "prod". * `(metadata.@ * type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadat * a) AND` \ `(metadata.name:howl) AND` \ `(metadata.progress.start_time < * \"2018-03-28T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * * The operation's metadata type is CreateBackupMetadata. * The backup name * contains the string "howl". * The operation started before * 2018-03-28T14:50:00Z. * The operation resulted in an error. * `(metadata.@typ * e=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) * AND` \ `(metadata.source_backup:test) AND` \ `(metadata.progress.start_time < * \"2022-01-18T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * * The operation's metadata type is CopyBackupMetadata. * The source backup name * contains the string "test". * The operation started before * 2022-01-18T14:50:00Z. * The operation resulted in an error. * `((metadata.@ty * pe=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) * AND` \ `(metadata.database:test_db)) OR` \ `((metadata.@type=type.googleapis. * com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \ * `(metadata.source_backup:test_bkp)) AND` \ `(error:*)` - Returns operations * where: * The operation's metadata matches either of criteria: * The * operation's metadata type is CreateBackupMetadata AND the source database * name of the backup contains the string "test_db" * The operation's metadata * type is CopyBackupMetadata AND the source backup name contains the string * "test_bkp" * The operation resulted in an error. * @opt_param int pageSize Number of operations to be returned in the response. * If 0 or less, defaults to the server's maximum allowed page size. * @opt_param string pageToken If non-empty, `page_token` should contain a * next_page_token from a previous ListBackupOperationsResponse to the same * `parent` and with the same `filter`. * @return ListBackupOperationsResponse * @throws \Google\Service\Exception */ public function listProjectsInstancesBackupOperations($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListBackupOperationsResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsInstancesBackupOperations::class, 'Google_Service_Spanner_Resource_ProjectsInstancesBackupOperations');