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\Aiplatform\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Aiplatform\GoogleCloudAiplatformV1FeatureGroup;
|
---|
21 | use Google\Service\Aiplatform\GoogleCloudAiplatformV1ListFeatureGroupsResponse;
|
---|
22 | use Google\Service\Aiplatform\GoogleLongrunningOperation;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The "featureGroups" collection of methods.
|
---|
26 | * Typical usage is:
|
---|
27 | * <code>
|
---|
28 | * $aiplatformService = new Google\Service\Aiplatform(...);
|
---|
29 | * $featureGroups = $aiplatformService->projects_locations_featureGroups;
|
---|
30 | * </code>
|
---|
31 | */
|
---|
32 | class ProjectsLocationsFeatureGroups extends \Google\Service\Resource
|
---|
33 | {
|
---|
34 | /**
|
---|
35 | * Creates a new FeatureGroup in a given project and location.
|
---|
36 | * (featureGroups.create)
|
---|
37 | *
|
---|
38 | * @param string $parent Required. The resource name of the Location to create
|
---|
39 | * FeatureGroups. Format: `projects/{project}/locations/{location}`
|
---|
40 | * @param GoogleCloudAiplatformV1FeatureGroup $postBody
|
---|
41 | * @param array $optParams Optional parameters.
|
---|
42 | *
|
---|
43 | * @opt_param string featureGroupId Required. The ID to use for this
|
---|
44 | * FeatureGroup, which will become the final component of the FeatureGroup's
|
---|
45 | * resource name. This value may be up to 128 characters, and valid characters
|
---|
46 | * are `[a-z0-9_]`. The first character cannot be a number. The value must be
|
---|
47 | * unique within the project and location.
|
---|
48 | * @return GoogleLongrunningOperation
|
---|
49 | * @throws \Google\Service\Exception
|
---|
50 | */
|
---|
51 | public function create($parent, GoogleCloudAiplatformV1FeatureGroup $postBody, $optParams = [])
|
---|
52 | {
|
---|
53 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
54 | $params = array_merge($params, $optParams);
|
---|
55 | return $this->call('create', [$params], GoogleLongrunningOperation::class);
|
---|
56 | }
|
---|
57 | /**
|
---|
58 | * Deletes a single FeatureGroup. (featureGroups.delete)
|
---|
59 | *
|
---|
60 | * @param string $name Required. The name of the FeatureGroup to be deleted.
|
---|
61 | * Format:
|
---|
62 | * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
|
---|
63 | * @param array $optParams Optional parameters.
|
---|
64 | *
|
---|
65 | * @opt_param bool force If set to true, any Features under this FeatureGroup
|
---|
66 | * will also be deleted. (Otherwise, the request will only work if the
|
---|
67 | * FeatureGroup has no Features.)
|
---|
68 | * @return GoogleLongrunningOperation
|
---|
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], GoogleLongrunningOperation::class);
|
---|
76 | }
|
---|
77 | /**
|
---|
78 | * Gets details of a single FeatureGroup. (featureGroups.get)
|
---|
79 | *
|
---|
80 | * @param string $name Required. The name of the FeatureGroup resource.
|
---|
81 | * @param array $optParams Optional parameters.
|
---|
82 | * @return GoogleCloudAiplatformV1FeatureGroup
|
---|
83 | * @throws \Google\Service\Exception
|
---|
84 | */
|
---|
85 | public function get($name, $optParams = [])
|
---|
86 | {
|
---|
87 | $params = ['name' => $name];
|
---|
88 | $params = array_merge($params, $optParams);
|
---|
89 | return $this->call('get', [$params], GoogleCloudAiplatformV1FeatureGroup::class);
|
---|
90 | }
|
---|
91 | /**
|
---|
92 | * Lists FeatureGroups in a given project and location.
|
---|
93 | * (featureGroups.listProjectsLocationsFeatureGroups)
|
---|
94 | *
|
---|
95 | * @param string $parent Required. The resource name of the Location to list
|
---|
96 | * FeatureGroups. Format: `projects/{project}/locations/{location}`
|
---|
97 | * @param array $optParams Optional parameters.
|
---|
98 | *
|
---|
99 | * @opt_param string filter Lists the FeatureGroups that match the filter
|
---|
100 | * expression. The following fields are supported: * `create_time`: Supports
|
---|
101 | * `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339
|
---|
102 | * format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=`
|
---|
103 | * comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-
|
---|
104 | * value equality and key presence. Examples: * `create_time > "2020-01-01" OR
|
---|
105 | * update_time > "2020-01-01"` FeatureGroups created or updated after
|
---|
106 | * 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to
|
---|
107 | * "prod".
|
---|
108 | * @opt_param string orderBy A comma-separated list of fields to order by,
|
---|
109 | * sorted in ascending order. Use "desc" after a field name for descending.
|
---|
110 | * Supported Fields: * `create_time` * `update_time`
|
---|
111 | * @opt_param int pageSize The maximum number of FeatureGroups to return. The
|
---|
112 | * service may return fewer than this value. If unspecified, at most 100
|
---|
113 | * FeatureGroups will be returned. The maximum value is 100; any value greater
|
---|
114 | * than 100 will be coerced to 100.
|
---|
115 | * @opt_param string pageToken A page token, received from a previous
|
---|
116 | * FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the
|
---|
117 | * subsequent page. When paginating, all other parameters provided to
|
---|
118 | * FeatureRegistryService.ListFeatureGroups must match the call that provided
|
---|
119 | * the page token.
|
---|
120 | * @return GoogleCloudAiplatformV1ListFeatureGroupsResponse
|
---|
121 | * @throws \Google\Service\Exception
|
---|
122 | */
|
---|
123 | public function listProjectsLocationsFeatureGroups($parent, $optParams = [])
|
---|
124 | {
|
---|
125 | $params = ['parent' => $parent];
|
---|
126 | $params = array_merge($params, $optParams);
|
---|
127 | return $this->call('list', [$params], GoogleCloudAiplatformV1ListFeatureGroupsResponse::class);
|
---|
128 | }
|
---|
129 | /**
|
---|
130 | * Updates the parameters of a single FeatureGroup. (featureGroups.patch)
|
---|
131 | *
|
---|
132 | * @param string $name Identifier. Name of the FeatureGroup. Format:
|
---|
133 | * `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
|
---|
134 | * @param GoogleCloudAiplatformV1FeatureGroup $postBody
|
---|
135 | * @param array $optParams Optional parameters.
|
---|
136 | *
|
---|
137 | * @opt_param string updateMask Field mask is used to specify the fields to be
|
---|
138 | * overwritten in the FeatureGroup resource by the update. The fields specified
|
---|
139 | * in the update_mask are relative to the resource, not the full request. A
|
---|
140 | * field will be overwritten if it is in the mask. If the user does not provide
|
---|
141 | * a mask then only the non-empty fields present in the request will be
|
---|
142 | * overwritten. Set the update_mask to `*` to override all fields. Updatable
|
---|
143 | * fields: * `labels` * `description` * `big_query` *
|
---|
144 | * `big_query.entity_id_columns`
|
---|
145 | * @return GoogleLongrunningOperation
|
---|
146 | * @throws \Google\Service\Exception
|
---|
147 | */
|
---|
148 | public function patch($name, GoogleCloudAiplatformV1FeatureGroup $postBody, $optParams = [])
|
---|
149 | {
|
---|
150 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
151 | $params = array_merge($params, $optParams);
|
---|
152 | return $this->call('patch', [$params], GoogleLongrunningOperation::class);
|
---|
153 | }
|
---|
154 | }
|
---|
155 |
|
---|
156 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
157 | class_alias(ProjectsLocationsFeatureGroups::class, 'Google_Service_Aiplatform_Resource_ProjectsLocationsFeatureGroups');
|
---|