source: vendor/google/apiclient-services/src/BigtableAdmin/Resource/ProjectsInstancesTablesAuthorizedViews.php

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

Upload project files

  • Property mode set to 100644
File size: 9.4 KB
RevLine 
[e3d4e0a]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\BigtableAdmin\Resource;
19
20use Google\Service\BigtableAdmin\AuthorizedView;
21use Google\Service\BigtableAdmin\BigtableadminEmpty;
22use Google\Service\BigtableAdmin\GetIamPolicyRequest;
23use Google\Service\BigtableAdmin\ListAuthorizedViewsResponse;
24use Google\Service\BigtableAdmin\Operation;
25use Google\Service\BigtableAdmin\Policy;
26use Google\Service\BigtableAdmin\SetIamPolicyRequest;
27use Google\Service\BigtableAdmin\TestIamPermissionsRequest;
28use Google\Service\BigtableAdmin\TestIamPermissionsResponse;
29
30/**
31 * The "authorizedViews" collection of methods.
32 * Typical usage is:
33 * <code>
34 * $bigtableadminService = new Google\Service\BigtableAdmin(...);
35 * $authorizedViews = $bigtableadminService->projects_instances_tables_authorizedViews;
36 * </code>
37 */
38class ProjectsInstancesTablesAuthorizedViews extends \Google\Service\Resource
39{
40 /**
41 * Creates a new AuthorizedView in a table. (authorizedViews.create)
42 *
43 * @param string $parent Required. This is the name of the table the
44 * AuthorizedView belongs to. Values are of the form
45 * `projects/{project}/instances/{instance}/tables/{table}`.
46 * @param AuthorizedView $postBody
47 * @param array $optParams Optional parameters.
48 *
49 * @opt_param string authorizedViewId Required. The id of the AuthorizedView to
50 * create. This AuthorizedView must not already exist. The `authorized_view_id`
51 * appended to `parent` forms the full AuthorizedView name of the form `projects
52 * /{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_vie
53 * w}`.
54 * @return Operation
55 * @throws \Google\Service\Exception
56 */
57 public function create($parent, AuthorizedView $postBody, $optParams = [])
58 {
59 $params = ['parent' => $parent, 'postBody' => $postBody];
60 $params = array_merge($params, $optParams);
61 return $this->call('create', [$params], Operation::class);
62 }
63 /**
64 * Permanently deletes a specified AuthorizedView. (authorizedViews.delete)
65 *
66 * @param string $name Required. The unique name of the AuthorizedView to be
67 * deleted. Values are of the form `projects/{project}/instances/{instance}/tabl
68 * es/{table}/authorizedViews/{authorized_view}`.
69 * @param array $optParams Optional parameters.
70 *
71 * @opt_param string etag Optional. The current etag of the AuthorizedView. If
72 * an etag is provided and does not match the current etag of the
73 * AuthorizedView, deletion will be blocked and an ABORTED error will be
74 * returned.
75 * @return BigtableadminEmpty
76 * @throws \Google\Service\Exception
77 */
78 public function delete($name, $optParams = [])
79 {
80 $params = ['name' => $name];
81 $params = array_merge($params, $optParams);
82 return $this->call('delete', [$params], BigtableadminEmpty::class);
83 }
84 /**
85 * Gets information from a specified AuthorizedView. (authorizedViews.get)
86 *
87 * @param string $name Required. The unique name of the requested
88 * AuthorizedView. Values are of the form `projects/{project}/instances/{instanc
89 * e}/tables/{table}/authorizedViews/{authorized_view}`.
90 * @param array $optParams Optional parameters.
91 *
92 * @opt_param string view Optional. The resource_view to be applied to the
93 * returned AuthorizedView's fields. Default to BASIC.
94 * @return AuthorizedView
95 * @throws \Google\Service\Exception
96 */
97 public function get($name, $optParams = [])
98 {
99 $params = ['name' => $name];
100 $params = array_merge($params, $optParams);
101 return $this->call('get', [$params], AuthorizedView::class);
102 }
103 /**
104 * Gets the access control policy for a Bigtable resource. Returns an empty
105 * policy if the resource exists but does not have a policy set.
106 * (authorizedViews.getIamPolicy)
107 *
108 * @param string $resource REQUIRED: The resource for which the policy is being
109 * requested. See [Resource
110 * names](https://cloud.google.com/apis/design/resource_names) for the
111 * appropriate value for this field.
112 * @param GetIamPolicyRequest $postBody
113 * @param array $optParams Optional parameters.
114 * @return Policy
115 * @throws \Google\Service\Exception
116 */
117 public function getIamPolicy($resource, GetIamPolicyRequest $postBody, $optParams = [])
118 {
119 $params = ['resource' => $resource, 'postBody' => $postBody];
120 $params = array_merge($params, $optParams);
121 return $this->call('getIamPolicy', [$params], Policy::class);
122 }
123 /**
124 * Lists all AuthorizedViews from a specific table.
125 * (authorizedViews.listProjectsInstancesTablesAuthorizedViews)
126 *
127 * @param string $parent Required. The unique name of the table for which
128 * AuthorizedViews should be listed. Values are of the form
129 * `projects/{project}/instances/{instance}/tables/{table}`.
130 * @param array $optParams Optional parameters.
131 *
132 * @opt_param int pageSize Optional. Maximum number of results per page. A
133 * page_size of zero lets the server choose the number of items to return. A
134 * page_size which is strictly positive will return at most that many items. A
135 * negative page_size will cause an error. Following the first request,
136 * subsequent paginated calls are not required to pass a page_size. If a
137 * page_size is set in subsequent calls, it must match the page_size given in
138 * the first request.
139 * @opt_param string pageToken Optional. The value of `next_page_token` returned
140 * by a previous call.
141 * @opt_param string view Optional. The resource_view to be applied to the
142 * returned AuthorizedViews' fields. Default to NAME_ONLY.
143 * @return ListAuthorizedViewsResponse
144 * @throws \Google\Service\Exception
145 */
146 public function listProjectsInstancesTablesAuthorizedViews($parent, $optParams = [])
147 {
148 $params = ['parent' => $parent];
149 $params = array_merge($params, $optParams);
150 return $this->call('list', [$params], ListAuthorizedViewsResponse::class);
151 }
152 /**
153 * Updates an AuthorizedView in a table. (authorizedViews.patch)
154 *
155 * @param string $name Identifier. The name of this AuthorizedView. Values are
156 * of the form `projects/{project}/instances/{instance}/tables/{table}/authorize
157 * dViews/{authorized_view}`
158 * @param AuthorizedView $postBody
159 * @param array $optParams Optional parameters.
160 *
161 * @opt_param bool ignoreWarnings Optional. If true, ignore the safety checks
162 * when updating the AuthorizedView.
163 * @opt_param string updateMask Optional. The list of fields to update. A mask
164 * specifying which fields in the AuthorizedView resource should be updated.
165 * This mask is relative to the AuthorizedView resource, not to the request
166 * message. A field will be overwritten if it is in the mask. If empty, all
167 * fields set in the request will be overwritten. A special value `*` means to
168 * overwrite all fields (including fields not set in the request).
169 * @return Operation
170 * @throws \Google\Service\Exception
171 */
172 public function patch($name, AuthorizedView $postBody, $optParams = [])
173 {
174 $params = ['name' => $name, 'postBody' => $postBody];
175 $params = array_merge($params, $optParams);
176 return $this->call('patch', [$params], Operation::class);
177 }
178 /**
179 * Sets the access control policy on a Bigtable resource. Replaces any existing
180 * policy. (authorizedViews.setIamPolicy)
181 *
182 * @param string $resource REQUIRED: The resource for which the policy is being
183 * specified. See [Resource
184 * names](https://cloud.google.com/apis/design/resource_names) for the
185 * appropriate value for this field.
186 * @param SetIamPolicyRequest $postBody
187 * @param array $optParams Optional parameters.
188 * @return Policy
189 * @throws \Google\Service\Exception
190 */
191 public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
192 {
193 $params = ['resource' => $resource, 'postBody' => $postBody];
194 $params = array_merge($params, $optParams);
195 return $this->call('setIamPolicy', [$params], Policy::class);
196 }
197 /**
198 * Returns permissions that the caller has on the specified Bigtable resource.
199 * (authorizedViews.testIamPermissions)
200 *
201 * @param string $resource REQUIRED: The resource for which the policy detail is
202 * being requested. See [Resource
203 * names](https://cloud.google.com/apis/design/resource_names) for the
204 * appropriate value for this field.
205 * @param TestIamPermissionsRequest $postBody
206 * @param array $optParams Optional parameters.
207 * @return TestIamPermissionsResponse
208 * @throws \Google\Service\Exception
209 */
210 public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
211 {
212 $params = ['resource' => $resource, 'postBody' => $postBody];
213 $params = array_merge($params, $optParams);
214 return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
215 }
216}
217
218// Adding a class alias for backwards compatibility with the previous class name.
219class_alias(ProjectsInstancesTablesAuthorizedViews::class, 'Google_Service_BigtableAdmin_Resource_ProjectsInstancesTablesAuthorizedViews');
Note: See TracBrowser for help on using the repository browser.