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\GoogleCloudAiplatformV1Dataset;
|
---|
21 | use Google\Service\Aiplatform\GoogleCloudAiplatformV1ListDatasetsResponse;
|
---|
22 | use Google\Service\Aiplatform\GoogleLongrunningOperation;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The "datasets" collection of methods.
|
---|
26 | * Typical usage is:
|
---|
27 | * <code>
|
---|
28 | * $aiplatformService = new Google\Service\Aiplatform(...);
|
---|
29 | * $datasets = $aiplatformService->datasets;
|
---|
30 | * </code>
|
---|
31 | */
|
---|
32 | class Datasets extends \Google\Service\Resource
|
---|
33 | {
|
---|
34 | /**
|
---|
35 | * Creates a Dataset. (datasets.create)
|
---|
36 | *
|
---|
37 | * @param GoogleCloudAiplatformV1Dataset $postBody
|
---|
38 | * @param array $optParams Optional parameters.
|
---|
39 | *
|
---|
40 | * @opt_param string parent Required. The resource name of the Location to
|
---|
41 | * create the Dataset in. Format: `projects/{project}/locations/{location}`
|
---|
42 | * @return GoogleLongrunningOperation
|
---|
43 | * @throws \Google\Service\Exception
|
---|
44 | */
|
---|
45 | public function create(GoogleCloudAiplatformV1Dataset $postBody, $optParams = [])
|
---|
46 | {
|
---|
47 | $params = ['postBody' => $postBody];
|
---|
48 | $params = array_merge($params, $optParams);
|
---|
49 | return $this->call('create', [$params], GoogleLongrunningOperation::class);
|
---|
50 | }
|
---|
51 | /**
|
---|
52 | * Deletes a Dataset. (datasets.delete)
|
---|
53 | *
|
---|
54 | * @param string $name Required. The resource name of the Dataset to delete.
|
---|
55 | * Format: `projects/{project}/locations/{location}/datasets/{dataset}`
|
---|
56 | * @param array $optParams Optional parameters.
|
---|
57 | * @return GoogleLongrunningOperation
|
---|
58 | * @throws \Google\Service\Exception
|
---|
59 | */
|
---|
60 | public function delete($name, $optParams = [])
|
---|
61 | {
|
---|
62 | $params = ['name' => $name];
|
---|
63 | $params = array_merge($params, $optParams);
|
---|
64 | return $this->call('delete', [$params], GoogleLongrunningOperation::class);
|
---|
65 | }
|
---|
66 | /**
|
---|
67 | * Gets a Dataset. (datasets.get)
|
---|
68 | *
|
---|
69 | * @param string $name Required. The name of the Dataset resource.
|
---|
70 | * @param array $optParams Optional parameters.
|
---|
71 | *
|
---|
72 | * @opt_param string readMask Mask specifying which fields to read.
|
---|
73 | * @return GoogleCloudAiplatformV1Dataset
|
---|
74 | * @throws \Google\Service\Exception
|
---|
75 | */
|
---|
76 | public function get($name, $optParams = [])
|
---|
77 | {
|
---|
78 | $params = ['name' => $name];
|
---|
79 | $params = array_merge($params, $optParams);
|
---|
80 | return $this->call('get', [$params], GoogleCloudAiplatformV1Dataset::class);
|
---|
81 | }
|
---|
82 | /**
|
---|
83 | * Lists Datasets in a Location. (datasets.listDatasets)
|
---|
84 | *
|
---|
85 | * @param array $optParams Optional parameters.
|
---|
86 | *
|
---|
87 | * @opt_param string filter An expression for filtering the results of the
|
---|
88 | * request. For field names both snake_case and camelCase are supported. *
|
---|
89 | * `display_name`: supports = and != * `metadata_schema_uri`: supports = and !=
|
---|
90 | * * `labels` supports general map functions that is: * `labels.key=value` -
|
---|
91 | * key:value equality * `labels.key:* or labels:key - key existence * A key
|
---|
92 | * including a space must be quoted. `labels."a key"`. Some examples: *
|
---|
93 | * `displayName="myDisplayName"` * `labels.myKey="myValue"`
|
---|
94 | * @opt_param string orderBy A comma-separated list of fields to order by,
|
---|
95 | * sorted in ascending order. Use "desc" after a field name for descending.
|
---|
96 | * Supported fields: * `display_name` * `create_time` * `update_time`
|
---|
97 | * @opt_param int pageSize The standard list page size.
|
---|
98 | * @opt_param string pageToken The standard list page token.
|
---|
99 | * @opt_param string parent Required. The name of the Dataset's parent resource.
|
---|
100 | * Format: `projects/{project}/locations/{location}`
|
---|
101 | * @opt_param string readMask Mask specifying which fields to read.
|
---|
102 | * @return GoogleCloudAiplatformV1ListDatasetsResponse
|
---|
103 | * @throws \Google\Service\Exception
|
---|
104 | */
|
---|
105 | public function listDatasets($optParams = [])
|
---|
106 | {
|
---|
107 | $params = [];
|
---|
108 | $params = array_merge($params, $optParams);
|
---|
109 | return $this->call('list', [$params], GoogleCloudAiplatformV1ListDatasetsResponse::class);
|
---|
110 | }
|
---|
111 | /**
|
---|
112 | * Updates a Dataset. (datasets.patch)
|
---|
113 | *
|
---|
114 | * @param string $name Output only. Identifier. The resource name of the
|
---|
115 | * Dataset.
|
---|
116 | * @param GoogleCloudAiplatformV1Dataset $postBody
|
---|
117 | * @param array $optParams Optional parameters.
|
---|
118 | *
|
---|
119 | * @opt_param string updateMask Required. The update mask applies to the
|
---|
120 | * resource. For the `FieldMask` definition, see google.protobuf.FieldMask.
|
---|
121 | * Updatable fields: * `display_name` * `description` * `labels`
|
---|
122 | * @return GoogleCloudAiplatformV1Dataset
|
---|
123 | * @throws \Google\Service\Exception
|
---|
124 | */
|
---|
125 | public function patch($name, GoogleCloudAiplatformV1Dataset $postBody, $optParams = [])
|
---|
126 | {
|
---|
127 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
128 | $params = array_merge($params, $optParams);
|
---|
129 | return $this->call('patch', [$params], GoogleCloudAiplatformV1Dataset::class);
|
---|
130 | }
|
---|
131 | }
|
---|
132 |
|
---|
133 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
134 | class_alias(Datasets::class, 'Google_Service_Aiplatform_Resource_Datasets');
|
---|