source: vendor/google/apiclient-services/src/Compute/Resource/RegionSslCertificates.php

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

Upload project files

  • Property mode set to 100644
File size: 9.4 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\Compute\Resource;
19
20use Google\Service\Compute\Operation;
21use Google\Service\Compute\SslCertificate;
22use Google\Service\Compute\SslCertificateList;
23
24/**
25 * The "regionSslCertificates" collection of methods.
26 * Typical usage is:
27 * <code>
28 * $computeService = new Google\Service\Compute(...);
29 * $regionSslCertificates = $computeService->regionSslCertificates;
30 * </code>
31 */
32class RegionSslCertificates extends \Google\Service\Resource
33{
34 /**
35 * Deletes the specified SslCertificate resource in the region.
36 * (regionSslCertificates.delete)
37 *
38 * @param string $project Project ID for this request.
39 * @param string $region Name of the region scoping this request.
40 * @param string $sslCertificate Name of the SslCertificate resource to delete.
41 * @param array $optParams Optional parameters.
42 *
43 * @opt_param string requestId An optional request ID to identify requests.
44 * Specify a unique request ID so that if you must retry your request, the
45 * server will know to ignore the request if it has already been completed. For
46 * example, consider a situation where you make an initial request and the
47 * request times out. If you make the request again with the same request ID,
48 * the server can check if original operation with the same request ID was
49 * received, and if so, will ignore the second request. This prevents clients
50 * from accidentally creating duplicate commitments. The request ID must be a
51 * valid UUID with the exception that zero UUID is not supported (
52 * 00000000-0000-0000-0000-000000000000).
53 * @return Operation
54 * @throws \Google\Service\Exception
55 */
56 public function delete($project, $region, $sslCertificate, $optParams = [])
57 {
58 $params = ['project' => $project, 'region' => $region, 'sslCertificate' => $sslCertificate];
59 $params = array_merge($params, $optParams);
60 return $this->call('delete', [$params], Operation::class);
61 }
62 /**
63 * Returns the specified SslCertificate resource in the specified region. Get a
64 * list of available SSL certificates by making a list() request.
65 * (regionSslCertificates.get)
66 *
67 * @param string $project Project ID for this request.
68 * @param string $region Name of the region scoping this request.
69 * @param string $sslCertificate Name of the SslCertificate resource to return.
70 * @param array $optParams Optional parameters.
71 * @return SslCertificate
72 * @throws \Google\Service\Exception
73 */
74 public function get($project, $region, $sslCertificate, $optParams = [])
75 {
76 $params = ['project' => $project, 'region' => $region, 'sslCertificate' => $sslCertificate];
77 $params = array_merge($params, $optParams);
78 return $this->call('get', [$params], SslCertificate::class);
79 }
80 /**
81 * Creates a SslCertificate resource in the specified project and region using
82 * the data included in the request (regionSslCertificates.insert)
83 *
84 * @param string $project Project ID for this request.
85 * @param string $region Name of the region scoping this request.
86 * @param SslCertificate $postBody
87 * @param array $optParams Optional parameters.
88 *
89 * @opt_param string requestId An optional request ID to identify requests.
90 * Specify a unique request ID so that if you must retry your request, the
91 * server will know to ignore the request if it has already been completed. For
92 * example, consider a situation where you make an initial request and the
93 * request times out. If you make the request again with the same request ID,
94 * the server can check if original operation with the same request ID was
95 * received, and if so, will ignore the second request. This prevents clients
96 * from accidentally creating duplicate commitments. The request ID must be a
97 * valid UUID with the exception that zero UUID is not supported (
98 * 00000000-0000-0000-0000-000000000000).
99 * @return Operation
100 * @throws \Google\Service\Exception
101 */
102 public function insert($project, $region, SslCertificate $postBody, $optParams = [])
103 {
104 $params = ['project' => $project, 'region' => $region, 'postBody' => $postBody];
105 $params = array_merge($params, $optParams);
106 return $this->call('insert', [$params], Operation::class);
107 }
108 /**
109 * Retrieves the list of SslCertificate resources available to the specified
110 * project in the specified region.
111 * (regionSslCertificates.listRegionSslCertificates)
112 *
113 * @param string $project Project ID for this request.
114 * @param string $region Name of the region scoping this request.
115 * @param array $optParams Optional parameters.
116 *
117 * @opt_param string filter A filter expression that filters resources listed in
118 * the response. Most Compute resources support two types of filter expressions:
119 * expressions that support regular expressions and expressions that follow API
120 * improvement proposal AIP-160. These two types of filter expressions cannot be
121 * mixed in one request. If you want to use AIP-160, your expression must
122 * specify the field name, an operator, and the value that you want to use for
123 * filtering. The value must be a string, a number, or a boolean. The operator
124 * must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you
125 * are filtering Compute Engine instances, you can exclude instances named
126 * `example-instance` by specifying `name != example-instance`. The `:*`
127 * comparison can be used to test whether a key has been defined. For example,
128 * to find all objects with `owner` label use: ``` labels.owner:* ``` You can
129 * also filter nested fields. For example, you could specify
130 * `scheduling.automaticRestart = false` to include instances only if they are
131 * not scheduled for automatic restarts. You can use filtering on nested fields
132 * to filter based on resource labels. To filter on multiple expressions,
133 * provide each separate expression within parentheses. For example: ```
134 * (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By
135 * default, each expression is an `AND` expression. However, you can include
136 * `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel
137 * Skylake") OR (cpuPlatform = "Intel Broadwell") AND
138 * (scheduling.automaticRestart = true) ``` If you want to use a regular
139 * expression, use the `eq` (equal) or `ne` (not equal) operator against a
140 * single un-parenthesized expression with or without quotes or against multiple
141 * parenthesized expressions. Examples: `fieldname eq unquoted literal`
142 * `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"`
143 * `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is
144 * interpreted as a regular expression using Google RE2 library syntax. The
145 * literal value must match the entire field. For example, to filter for
146 * instances that do not end with name "instance", you would use `name ne
147 * .*instance`. You cannot combine constraints on multiple fields using regular
148 * expressions.
149 * @opt_param string maxResults The maximum number of results per page that
150 * should be returned. If the number of available results is larger than
151 * `maxResults`, Compute Engine returns a `nextPageToken` that can be used to
152 * get the next page of results in subsequent list requests. Acceptable values
153 * are `0` to `500`, inclusive. (Default: `500`)
154 * @opt_param string orderBy Sorts list results by a certain order. By default,
155 * results are returned in alphanumerical order based on the resource name. You
156 * can also sort results in descending order based on the creation timestamp
157 * using `orderBy="creationTimestamp desc"`. This sorts results based on the
158 * `creationTimestamp` field in reverse chronological order (newest result
159 * first). Use this to sort resources like operations so that the newest
160 * operation is returned first. Currently, only sorting by `name` or
161 * `creationTimestamp desc` is supported.
162 * @opt_param string pageToken Specifies a page token to use. Set `pageToken` to
163 * the `nextPageToken` returned by a previous list request to get the next page
164 * of results.
165 * @opt_param bool returnPartialSuccess Opt-in for partial success behavior
166 * which provides partial results in case of failure. The default value is
167 * false. For example, when partial success behavior is enabled, aggregatedList
168 * for a single zone scope either returns all resources in the zone or no
169 * resources, with an error code.
170 * @return SslCertificateList
171 * @throws \Google\Service\Exception
172 */
173 public function listRegionSslCertificates($project, $region, $optParams = [])
174 {
175 $params = ['project' => $project, 'region' => $region];
176 $params = array_merge($params, $optParams);
177 return $this->call('list', [$params], SslCertificateList::class);
178 }
179}
180
181// Adding a class alias for backwards compatibility with the previous class name.
182class_alias(RegionSslCertificates::class, 'Google_Service_Compute_Resource_RegionSslCertificates');
Note: See TracBrowser for help on using the repository browser.