source: vendor/google/apiclient-services/src/CertificateManager/Resource/ProjectsLocationsCertificates.php

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

Upload project files

  • Property mode set to 100644
File size: 5.2 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\CertificateManager\Resource;
19
20use Google\Service\CertificateManager\Certificate;
21use Google\Service\CertificateManager\ListCertificatesResponse;
22use Google\Service\CertificateManager\Operation;
23
24/**
25 * The "certificates" collection of methods.
26 * Typical usage is:
27 * <code>
28 * $certificatemanagerService = new Google\Service\CertificateManager(...);
29 * $certificates = $certificatemanagerService->projects_locations_certificates;
30 * </code>
31 */
32class ProjectsLocationsCertificates extends \Google\Service\Resource
33{
34 /**
35 * Creates a new Certificate in a given project and location.
36 * (certificates.create)
37 *
38 * @param string $parent Required. The parent resource of the certificate. Must
39 * be in the format `projects/locations`.
40 * @param Certificate $postBody
41 * @param array $optParams Optional parameters.
42 *
43 * @opt_param string certificateId Required. A user-provided name of the
44 * certificate.
45 * @return Operation
46 * @throws \Google\Service\Exception
47 */
48 public function create($parent, Certificate $postBody, $optParams = [])
49 {
50 $params = ['parent' => $parent, 'postBody' => $postBody];
51 $params = array_merge($params, $optParams);
52 return $this->call('create', [$params], Operation::class);
53 }
54 /**
55 * Deletes a single Certificate. (certificates.delete)
56 *
57 * @param string $name Required. A name of the certificate to delete. Must be in
58 * the format `projects/locations/certificates`.
59 * @param array $optParams Optional parameters.
60 * @return Operation
61 * @throws \Google\Service\Exception
62 */
63 public function delete($name, $optParams = [])
64 {
65 $params = ['name' => $name];
66 $params = array_merge($params, $optParams);
67 return $this->call('delete', [$params], Operation::class);
68 }
69 /**
70 * Gets details of a single Certificate. (certificates.get)
71 *
72 * @param string $name Required. A name of the certificate to describe. Must be
73 * in the format `projects/locations/certificates`.
74 * @param array $optParams Optional parameters.
75 * @return Certificate
76 * @throws \Google\Service\Exception
77 */
78 public function get($name, $optParams = [])
79 {
80 $params = ['name' => $name];
81 $params = array_merge($params, $optParams);
82 return $this->call('get', [$params], Certificate::class);
83 }
84 /**
85 * Lists Certificates in a given project and location.
86 * (certificates.listProjectsLocationsCertificates)
87 *
88 * @param string $parent Required. The project and location from which the
89 * certificate should be listed, specified in the format `projects/locations`.
90 * @param array $optParams Optional parameters.
91 *
92 * @opt_param string filter Optional. Filter expression to restrict the
93 * Certificates returned.
94 * @opt_param string orderBy Optional. A list of Certificate field names used to
95 * specify the order of the returned results. The default sorting order is
96 * ascending. To specify descending order for a field, add a suffix `" desc"`.
97 * @opt_param int pageSize Optional. Maximum number of certificates to return
98 * per call.
99 * @opt_param string pageToken Optional. The value returned by the last
100 * `ListCertificatesResponse`. Indicates that this is a continuation of a prior
101 * `ListCertificates` call, and that the system should return the next page of
102 * data.
103 * @return ListCertificatesResponse
104 * @throws \Google\Service\Exception
105 */
106 public function listProjectsLocationsCertificates($parent, $optParams = [])
107 {
108 $params = ['parent' => $parent];
109 $params = array_merge($params, $optParams);
110 return $this->call('list', [$params], ListCertificatesResponse::class);
111 }
112 /**
113 * Updates a Certificate. (certificates.patch)
114 *
115 * @param string $name Identifier. A user-defined name of the certificate.
116 * Certificate names must be unique globally and match pattern
117 * `projects/locations/certificates`.
118 * @param Certificate $postBody
119 * @param array $optParams Optional parameters.
120 *
121 * @opt_param string updateMask Required. The update mask applies to the
122 * resource. For the `FieldMask` definition, see
123 * https://developers.google.com/protocol-
124 * buffers/docs/reference/google.protobuf#fieldmask.
125 * @return Operation
126 * @throws \Google\Service\Exception
127 */
128 public function patch($name, Certificate $postBody, $optParams = [])
129 {
130 $params = ['name' => $name, 'postBody' => $postBody];
131 $params = array_merge($params, $optParams);
132 return $this->call('patch', [$params], Operation::class);
133 }
134}
135
136// Adding a class alias for backwards compatibility with the previous class name.
137class_alias(ProjectsLocationsCertificates::class, 'Google_Service_CertificateManager_Resource_ProjectsLocationsCertificates');
Note: See TracBrowser for help on using the repository browser.