source: vendor/google/apiclient-services/src/Spanner/Resource/ProjectsInstancesInstancePartitionOperations.php@ e3d4e0a

Last change on this file since e3d4e0a was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 10 days ago

Upload project files

  • Property mode set to 100644
File size: 5.2 KB
Line 
1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Spanner\Resource;
19
20use Google\Service\Spanner\ListInstancePartitionOperationsResponse;
21
22/**
23 * The "instancePartitionOperations" collection of methods.
24 * Typical usage is:
25 * <code>
26 * $spannerService = new Google\Service\Spanner(...);
27 * $instancePartitionOperations = $spannerService->projects_instances_instancePartitionOperations;
28 * </code>
29 */
30class ProjectsInstancesInstancePartitionOperations extends \Google\Service\Resource
31{
32 /**
33 * Lists instance partition long-running operations in the given instance. An
34 * instance partition operation has a name of the form
35 * `projects//instances//instancePartitions//operations/`. The long-running
36 * operation metadata field type `metadata.type_url` describes the type of the
37 * metadata. Operations returned include those that have
38 * completed/failed/canceled within the last 7 days, and pending operations.
39 * Operations returned are ordered by `operation.metadata.value.start_time` in
40 * descending order starting from the most recently started operation.
41 * Authorization requires `spanner.instancePartitionOperations.list` permission
42 * on the resource parent. (instancePartitionOperations.listProjectsInstancesIns
43 * tancePartitionOperations)
44 *
45 * @param string $parent Required. The parent instance of the instance partition
46 * operations. Values are of the form `projects//instances/`.
47 * @param array $optParams Optional parameters.
48 *
49 * @opt_param string filter Optional. An expression that filters the list of
50 * returned operations. A filter expression consists of a field name, a
51 * comparison operator, and a value for filtering. The value must be a string, a
52 * number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`,
53 * `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are
54 * not case sensitive. The following fields in the Operation are eligible for
55 * filtering: * `name` - The name of the long-running operation * `done` - False
56 * if the operation is in progress, else true. * `metadata.@type` - the type of
57 * metadata. For example, the type string for CreateInstancePartitionMetadata is
58 * `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartition
59 * Metadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must
60 * be specified first, if filtering on metadata fields. * `error` - Error
61 * associated with the long-running operation. * `response.@type` - the type of
62 * response. * `response.` - any field in response.value. You can combine
63 * multiple expressions by enclosing each expression in parentheses. By default,
64 * expressions are combined with AND logic. However, you can specify AND, OR,
65 * and NOT logic explicitly. Here are a few examples: * `done:true` - The
66 * operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spa
67 * nner.admin.instance.v1.CreateInstancePartitionMetadata) AND` \
68 * `(metadata.instance_partition.name:custom-instance-partition) AND` \
69 * `(metadata.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return
70 * operations where: * The operation's metadata type is
71 * CreateInstancePartitionMetadata. * The instance partition name contains
72 * "custom-instance-partition". * The operation started before
73 * 2021-03-28T14:50:00Z. * The operation resulted in an error.
74 * @opt_param string instancePartitionDeadline Optional. Deadline used while
75 * retrieving metadata for instance partition operations. Instance partitions
76 * whose operation metadata cannot be retrieved within this deadline will be
77 * added to unreachable_instance_partitions in
78 * ListInstancePartitionOperationsResponse.
79 * @opt_param int pageSize Optional. Number of operations to be returned in the
80 * response. If 0 or less, defaults to the server's maximum allowed page size.
81 * @opt_param string pageToken Optional. If non-empty, `page_token` should
82 * contain a next_page_token from a previous
83 * ListInstancePartitionOperationsResponse to the same `parent` and with the
84 * same `filter`.
85 * @return ListInstancePartitionOperationsResponse
86 * @throws \Google\Service\Exception
87 */
88 public function listProjectsInstancesInstancePartitionOperations($parent, $optParams = [])
89 {
90 $params = ['parent' => $parent];
91 $params = array_merge($params, $optParams);
92 return $this->call('list', [$params], ListInstancePartitionOperationsResponse::class);
93 }
94}
95
96// Adding a class alias for backwards compatibility with the previous class name.
97class_alias(ProjectsInstancesInstancePartitionOperations::class, 'Google_Service_Spanner_Resource_ProjectsInstancesInstancePartitionOperations');
Note: See TracBrowser for help on using the repository browser.