source: vendor/google/apiclient-services/src/MigrationCenterAPI/Resource/ProjectsLocationsReportConfigsReports.php

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

Upload project files

  • Property mode set to 100644
File size: 5.8 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\MigrationCenterAPI\Resource;
19
20use Google\Service\MigrationCenterAPI\ListReportsResponse;
21use Google\Service\MigrationCenterAPI\Operation;
22use Google\Service\MigrationCenterAPI\Report;
23
24/**
25 * The "reports" collection of methods.
26 * Typical usage is:
27 * <code>
28 * $migrationcenterService = new Google\Service\MigrationCenterAPI(...);
29 * $reports = $migrationcenterService->projects_locations_reportConfigs_reports;
30 * </code>
31 */
32class ProjectsLocationsReportConfigsReports extends \Google\Service\Resource
33{
34 /**
35 * Creates a report. (reports.create)
36 *
37 * @param string $parent Required. Value for parent.
38 * @param Report $postBody
39 * @param array $optParams Optional parameters.
40 *
41 * @opt_param string reportId Required. User specified id for the report. It
42 * will become the last component of the report name. The id must be unique
43 * within the project, must conform with RFC-1034, is restricted to lower-cased
44 * letters, and has a maximum length of 63 characters. The id must match the
45 * regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
46 * @opt_param string requestId Optional. An optional request ID to identify
47 * requests. Specify a unique request ID so that if you must retry your request,
48 * the server will know to ignore the request if it has already been completed.
49 * The server will guarantee that for at least 60 minutes since the first
50 * request. For example, consider a situation where you make an initial request
51 * and the request times out. If you make the request again with the same
52 * request ID, the server can check if original operation with the same request
53 * ID was received, and if so, will ignore the second request. This prevents
54 * clients from accidentally creating duplicate commitments. The request ID must
55 * be a valid UUID with the exception that zero UUID is not supported
56 * (00000000-0000-0000-0000-000000000000).
57 * @return Operation
58 * @throws \Google\Service\Exception
59 */
60 public function create($parent, Report $postBody, $optParams = [])
61 {
62 $params = ['parent' => $parent, 'postBody' => $postBody];
63 $params = array_merge($params, $optParams);
64 return $this->call('create', [$params], Operation::class);
65 }
66 /**
67 * Deletes a Report. (reports.delete)
68 *
69 * @param string $name Required. Name of the resource.
70 * @param array $optParams Optional parameters.
71 *
72 * @opt_param string requestId Optional. An optional request ID to identify
73 * requests. Specify a unique request ID so that if you must retry your request,
74 * the server will know to ignore the request if it has already been completed.
75 * The server will guarantee that for at least 60 minutes after the first
76 * request. For example, consider a situation where you make an initial request
77 * and the request times out. If you make the request again with the same
78 * request ID, the server can check if original operation with the same request
79 * ID was received, and if so, will ignore the second request. This prevents
80 * clients from accidentally creating duplicate commitments. The request ID must
81 * be a valid UUID with the exception that zero UUID is not supported
82 * (00000000-0000-0000-0000-000000000000).
83 * @return Operation
84 * @throws \Google\Service\Exception
85 */
86 public function delete($name, $optParams = [])
87 {
88 $params = ['name' => $name];
89 $params = array_merge($params, $optParams);
90 return $this->call('delete', [$params], Operation::class);
91 }
92 /**
93 * Gets details of a single Report. (reports.get)
94 *
95 * @param string $name Required. Name of the resource.
96 * @param array $optParams Optional parameters.
97 *
98 * @opt_param string view Determines what information to retrieve for the
99 * Report.
100 * @return Report
101 * @throws \Google\Service\Exception
102 */
103 public function get($name, $optParams = [])
104 {
105 $params = ['name' => $name];
106 $params = array_merge($params, $optParams);
107 return $this->call('get', [$params], Report::class);
108 }
109 /**
110 * Lists Reports in a given ReportConfig.
111 * (reports.listProjectsLocationsReportConfigsReports)
112 *
113 * @param string $parent Required. Parent value for `ListReportsRequest`.
114 * @param array $optParams Optional parameters.
115 *
116 * @opt_param string filter Filtering results.
117 * @opt_param string orderBy Field to sort by. See
118 * https://google.aip.dev/132#ordering for more details.
119 * @opt_param int pageSize Requested page size. The server may return fewer
120 * items than requested. If unspecified, the server will pick an appropriate
121 * default value.
122 * @opt_param string pageToken A token identifying a page of results that the
123 * server should return.
124 * @opt_param string view Determines what information to retrieve for each
125 * Report.
126 * @return ListReportsResponse
127 * @throws \Google\Service\Exception
128 */
129 public function listProjectsLocationsReportConfigsReports($parent, $optParams = [])
130 {
131 $params = ['parent' => $parent];
132 $params = array_merge($params, $optParams);
133 return $this->call('list', [$params], ListReportsResponse::class);
134 }
135}
136
137// Adding a class alias for backwards compatibility with the previous class name.
138class_alias(ProjectsLocationsReportConfigsReports::class, 'Google_Service_MigrationCenterAPI_Resource_ProjectsLocationsReportConfigsReports');
Note: See TracBrowser for help on using the repository browser.