[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 |
|
---|
| 18 | namespace Google\Service\BigtableAdmin\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\BigtableAdmin\AppProfile;
|
---|
| 21 | use Google\Service\BigtableAdmin\BigtableadminEmpty;
|
---|
| 22 | use Google\Service\BigtableAdmin\ListAppProfilesResponse;
|
---|
| 23 | use Google\Service\BigtableAdmin\Operation;
|
---|
| 24 |
|
---|
| 25 | /**
|
---|
| 26 | * The "appProfiles" collection of methods.
|
---|
| 27 | * Typical usage is:
|
---|
| 28 | * <code>
|
---|
| 29 | * $bigtableadminService = new Google\Service\BigtableAdmin(...);
|
---|
| 30 | * $appProfiles = $bigtableadminService->projects_instances_appProfiles;
|
---|
| 31 | * </code>
|
---|
| 32 | */
|
---|
| 33 | class ProjectsInstancesAppProfiles extends \Google\Service\Resource
|
---|
| 34 | {
|
---|
| 35 | /**
|
---|
| 36 | * Creates an app profile within an instance. (appProfiles.create)
|
---|
| 37 | *
|
---|
| 38 | * @param string $parent Required. The unique name of the instance in which to
|
---|
| 39 | * create the new app profile. Values are of the form
|
---|
| 40 | * `projects/{project}/instances/{instance}`.
|
---|
| 41 | * @param AppProfile $postBody
|
---|
| 42 | * @param array $optParams Optional parameters.
|
---|
| 43 | *
|
---|
| 44 | * @opt_param string appProfileId Required. The ID to be used when referring to
|
---|
| 45 | * the new app profile within its instance, e.g., just `myprofile` rather than
|
---|
| 46 | * `projects/myproject/instances/myinstance/appProfiles/myprofile`.
|
---|
| 47 | * @opt_param bool ignoreWarnings If true, ignore safety checks when creating
|
---|
| 48 | * the app profile.
|
---|
| 49 | * @return AppProfile
|
---|
| 50 | * @throws \Google\Service\Exception
|
---|
| 51 | */
|
---|
| 52 | public function create($parent, AppProfile $postBody, $optParams = [])
|
---|
| 53 | {
|
---|
| 54 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
| 55 | $params = array_merge($params, $optParams);
|
---|
| 56 | return $this->call('create', [$params], AppProfile::class);
|
---|
| 57 | }
|
---|
| 58 | /**
|
---|
| 59 | * Deletes an app profile from an instance. (appProfiles.delete)
|
---|
| 60 | *
|
---|
| 61 | * @param string $name Required. The unique name of the app profile to be
|
---|
| 62 | * deleted. Values are of the form
|
---|
| 63 | * `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
|
---|
| 64 | * @param array $optParams Optional parameters.
|
---|
| 65 | *
|
---|
| 66 | * @opt_param bool ignoreWarnings Required. If true, ignore safety checks when
|
---|
| 67 | * deleting the app profile.
|
---|
| 68 | * @return BigtableadminEmpty
|
---|
| 69 | * @throws \Google\Service\Exception
|
---|
| 70 | */
|
---|
| 71 | public function delete($name, $optParams = [])
|
---|
| 72 | {
|
---|
| 73 | $params = ['name' => $name];
|
---|
| 74 | $params = array_merge($params, $optParams);
|
---|
| 75 | return $this->call('delete', [$params], BigtableadminEmpty::class);
|
---|
| 76 | }
|
---|
| 77 | /**
|
---|
| 78 | * Gets information about an app profile. (appProfiles.get)
|
---|
| 79 | *
|
---|
| 80 | * @param string $name Required. The unique name of the requested app profile.
|
---|
| 81 | * Values are of the form
|
---|
| 82 | * `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
|
---|
| 83 | * @param array $optParams Optional parameters.
|
---|
| 84 | * @return AppProfile
|
---|
| 85 | * @throws \Google\Service\Exception
|
---|
| 86 | */
|
---|
| 87 | public function get($name, $optParams = [])
|
---|
| 88 | {
|
---|
| 89 | $params = ['name' => $name];
|
---|
| 90 | $params = array_merge($params, $optParams);
|
---|
| 91 | return $this->call('get', [$params], AppProfile::class);
|
---|
| 92 | }
|
---|
| 93 | /**
|
---|
| 94 | * Lists information about app profiles in an instance.
|
---|
| 95 | * (appProfiles.listProjectsInstancesAppProfiles)
|
---|
| 96 | *
|
---|
| 97 | * @param string $parent Required. The unique name of the instance for which a
|
---|
| 98 | * list of app profiles is requested. Values are of the form
|
---|
| 99 | * `projects/{project}/instances/{instance}`. Use `{instance} = '-'` to list
|
---|
| 100 | * AppProfiles for all Instances in a project, e.g.,
|
---|
| 101 | * `projects/myproject/instances/-`.
|
---|
| 102 | * @param array $optParams Optional parameters.
|
---|
| 103 | *
|
---|
| 104 | * @opt_param int pageSize Maximum number of results per page. A page_size of
|
---|
| 105 | * zero lets the server choose the number of items to return. A page_size which
|
---|
| 106 | * is strictly positive will return at most that many items. A negative
|
---|
| 107 | * page_size will cause an error. Following the first request, subsequent
|
---|
| 108 | * paginated calls are not required to pass a page_size. If a page_size is set
|
---|
| 109 | * in subsequent calls, it must match the page_size given in the first request.
|
---|
| 110 | * @opt_param string pageToken The value of `next_page_token` returned by a
|
---|
| 111 | * previous call.
|
---|
| 112 | * @return ListAppProfilesResponse
|
---|
| 113 | * @throws \Google\Service\Exception
|
---|
| 114 | */
|
---|
| 115 | public function listProjectsInstancesAppProfiles($parent, $optParams = [])
|
---|
| 116 | {
|
---|
| 117 | $params = ['parent' => $parent];
|
---|
| 118 | $params = array_merge($params, $optParams);
|
---|
| 119 | return $this->call('list', [$params], ListAppProfilesResponse::class);
|
---|
| 120 | }
|
---|
| 121 | /**
|
---|
| 122 | * Updates an app profile within an instance. (appProfiles.patch)
|
---|
| 123 | *
|
---|
| 124 | * @param string $name The unique name of the app profile. Values are of the
|
---|
| 125 | * form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.
|
---|
| 126 | * @param AppProfile $postBody
|
---|
| 127 | * @param array $optParams Optional parameters.
|
---|
| 128 | *
|
---|
| 129 | * @opt_param bool ignoreWarnings If true, ignore safety checks when updating
|
---|
| 130 | * the app profile.
|
---|
| 131 | * @opt_param string updateMask Required. The subset of app profile fields which
|
---|
| 132 | * should be replaced. If unset, all fields will be replaced.
|
---|
| 133 | * @return Operation
|
---|
| 134 | * @throws \Google\Service\Exception
|
---|
| 135 | */
|
---|
| 136 | public function patch($name, AppProfile $postBody, $optParams = [])
|
---|
| 137 | {
|
---|
| 138 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
| 139 | $params = array_merge($params, $optParams);
|
---|
| 140 | return $this->call('patch', [$params], Operation::class);
|
---|
| 141 | }
|
---|
| 142 | }
|
---|
| 143 |
|
---|
| 144 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 145 | class_alias(ProjectsInstancesAppProfiles::class, 'Google_Service_BigtableAdmin_Resource_ProjectsInstancesAppProfiles');
|
---|