-
Notifications
You must be signed in to change notification settings - Fork 458
Expand file tree
/
Copy pathServiceManagerClient.php
More file actions
781 lines (745 loc) · 34.1 KB
/
Copy pathServiceManagerClient.php
File metadata and controls
781 lines (745 loc) · 34.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
<?php
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* GENERATED CODE WARNING
* Generated by gapic-generator-php from the file
* https://github.com/googleapis/googleapis/blob/master/google/api/servicemanagement/v1/servicemanager.proto
* Updates to the above are reflected here through a refresh process.
*/
namespace Google\Cloud\ServiceManagement\V1\Client;
use Google\ApiCore\ApiException;
use Google\ApiCore\CredentialsWrapper;
use Google\ApiCore\GapicClientTrait;
use Google\ApiCore\OperationResponse;
use Google\ApiCore\Options\ClientOptions;
use Google\ApiCore\PagedListResponse;
use Google\ApiCore\RetrySettings;
use Google\ApiCore\Transport\TransportInterface;
use Google\ApiCore\ValidationException;
use Google\Api\Service;
use Google\Auth\FetchAuthTokenInterface;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\ServiceManagement\V1\CreateServiceConfigRequest;
use Google\Cloud\ServiceManagement\V1\CreateServiceRequest;
use Google\Cloud\ServiceManagement\V1\CreateServiceRolloutRequest;
use Google\Cloud\ServiceManagement\V1\DeleteServiceRequest;
use Google\Cloud\ServiceManagement\V1\GenerateConfigReportRequest;
use Google\Cloud\ServiceManagement\V1\GenerateConfigReportResponse;
use Google\Cloud\ServiceManagement\V1\GetServiceConfigRequest;
use Google\Cloud\ServiceManagement\V1\GetServiceRequest;
use Google\Cloud\ServiceManagement\V1\GetServiceRolloutRequest;
use Google\Cloud\ServiceManagement\V1\ListServiceConfigsRequest;
use Google\Cloud\ServiceManagement\V1\ListServiceRolloutsRequest;
use Google\Cloud\ServiceManagement\V1\ListServicesRequest;
use Google\Cloud\ServiceManagement\V1\ManagedService;
use Google\Cloud\ServiceManagement\V1\Rollout;
use Google\Cloud\ServiceManagement\V1\SubmitConfigSourceRequest;
use Google\Cloud\ServiceManagement\V1\SubmitConfigSourceResponse;
use Google\Cloud\ServiceManagement\V1\UndeleteServiceRequest;
use Google\Cloud\ServiceManagement\V1\UndeleteServiceResponse;
use Google\LongRunning\Client\OperationsClient;
use Google\LongRunning\Operation;
use GuzzleHttp\Promise\PromiseInterface;
use Psr\Log\LoggerInterface;
/**
* Service Description: [Google Service Management
* API](https://cloud.google.com/service-infrastructure/docs/overview)
*
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods.
*
* @method PromiseInterface<OperationResponse> createServiceAsync(CreateServiceRequest $request, array $optionalArgs = [])
* @method PromiseInterface<Service> createServiceConfigAsync(CreateServiceConfigRequest $request, array $optionalArgs = [])
* @method PromiseInterface<OperationResponse> createServiceRolloutAsync(CreateServiceRolloutRequest $request, array $optionalArgs = [])
* @method PromiseInterface<OperationResponse> deleteServiceAsync(DeleteServiceRequest $request, array $optionalArgs = [])
* @method PromiseInterface<GenerateConfigReportResponse> generateConfigReportAsync(GenerateConfigReportRequest $request, array $optionalArgs = [])
* @method PromiseInterface<ManagedService> getServiceAsync(GetServiceRequest $request, array $optionalArgs = [])
* @method PromiseInterface<Service> getServiceConfigAsync(GetServiceConfigRequest $request, array $optionalArgs = [])
* @method PromiseInterface<Rollout> getServiceRolloutAsync(GetServiceRolloutRequest $request, array $optionalArgs = [])
* @method PromiseInterface<PagedListResponse> listServiceConfigsAsync(ListServiceConfigsRequest $request, array $optionalArgs = [])
* @method PromiseInterface<PagedListResponse> listServiceRolloutsAsync(ListServiceRolloutsRequest $request, array $optionalArgs = [])
* @method PromiseInterface<PagedListResponse> listServicesAsync(ListServicesRequest $request, array $optionalArgs = [])
* @method PromiseInterface<OperationResponse> submitConfigSourceAsync(SubmitConfigSourceRequest $request, array $optionalArgs = [])
* @method PromiseInterface<OperationResponse> undeleteServiceAsync(UndeleteServiceRequest $request, array $optionalArgs = [])
* @method PromiseInterface<Policy> getIamPolicyAsync(GetIamPolicyRequest $request, array $optionalArgs = [])
* @method PromiseInterface<Policy> setIamPolicyAsync(SetIamPolicyRequest $request, array $optionalArgs = [])
* @method PromiseInterface<TestIamPermissionsResponse> testIamPermissionsAsync(TestIamPermissionsRequest $request, array $optionalArgs = [])
*/
final class ServiceManagerClient
{
use GapicClientTrait;
/** The name of the service. */
private const SERVICE_NAME = 'google.api.servicemanagement.v1.ServiceManager';
/**
* The default address of the service.
*
* @deprecated SERVICE_ADDRESS_TEMPLATE should be used instead.
*/
private const SERVICE_ADDRESS = 'servicemanagement.googleapis.com';
/** The address template of the service. */
private const SERVICE_ADDRESS_TEMPLATE = 'servicemanagement.UNIVERSE_DOMAIN';
/** The default port of the service. */
private const DEFAULT_SERVICE_PORT = 443;
/** The name of the code generator, to be included in the agent header. */
private const CODEGEN_NAME = 'gapic';
/** The default scopes required by the service. */
public static $serviceScopes = [
'https://www.googleapis.com/auth/cloud-platform',
'https://www.googleapis.com/auth/cloud-platform.read-only',
'https://www.googleapis.com/auth/service.management',
'https://www.googleapis.com/auth/service.management.readonly',
];
private $operationsClient;
private static function getClientDefaults()
{
return [
'serviceName' => self::SERVICE_NAME,
'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT,
'clientConfig' => __DIR__ . '/../resources/service_manager_client_config.json',
'descriptorsConfigPath' => __DIR__ . '/../resources/service_manager_descriptor_config.php',
'gcpApiConfigPath' => __DIR__ . '/../resources/service_manager_grpc_config.json',
'credentialsConfig' => [
'defaultScopes' => self::$serviceScopes,
],
'transportConfig' => [
'rest' => [
'restClientConfigPath' => __DIR__ . '/../resources/service_manager_rest_client_config.php',
],
],
];
}
/**
* Return an OperationsClient object with the same endpoint as $this.
*
* @return OperationsClient
*/
public function getOperationsClient()
{
return $this->operationsClient;
}
/**
* Resume an existing long running operation that was previously started by a long
* running API method. If $methodName is not provided, or does not match a long
* running API method, then the operation can still be resumed, but the
* OperationResponse object will not deserialize the final response.
*
* @param string $operationName The name of the long running operation
* @param string $methodName The name of the method used to start the operation
*
* @return OperationResponse
*/
public function resumeOperation($operationName, $methodName = null)
{
$options = $this->descriptors[$methodName]['longRunning'] ?? [];
$operation = new OperationResponse($operationName, $this->getOperationsClient(), $options);
$operation->reload();
return $operation;
}
/**
* Create the default operation client for the service.
*
* @param array $options ClientOptions for the client.
*
* @return OperationsClient
*/
private function createOperationsClient(array $options)
{
// Unset client-specific configuration options
unset($options['serviceName'], $options['clientConfig'], $options['descriptorsConfigPath']);
if (isset($options['operationsClient'])) {
return $options['operationsClient'];
}
return new OperationsClient($options);
}
/**
* Constructor.
*
* @param array|ClientOptions $options {
* Optional. Options for configuring the service API wrapper.
*
* @type string $apiEndpoint
* The address of the API remote host. May optionally include the port, formatted
* as "<uri>:<port>". Default 'servicemanagement.googleapis.com:443'.
* @type FetchAuthTokenInterface|CredentialsWrapper $credentials
* This option should only be used with a pre-constructed
* {@see FetchAuthTokenInterface} or {@see CredentialsWrapper} object. Note that
* when one of these objects are provided, any settings in $credentialsConfig will
* be ignored.
* **Important**: If you are providing a path to a credentials file, or a decoded
* credentials file as a PHP array, this usage is now DEPRECATED. Providing an
* unvalidated credential configuration to Google APIs can compromise the security
* of your systems and data. It is recommended to create the credentials explicitly
* ```
* use Google\Auth\Credentials\ServiceAccountCredentials;
* use Google\Cloud\ServiceManagement\V1\ServiceManagerClient;
* $creds = new ServiceAccountCredentials($scopes, $json);
* $options = new ServiceManagerClient(['credentials' => $creds]);
* ```
* {@see
* https://cloud.google.com/docs/authentication/external/externally-sourced-credentials}
* @type array $credentialsConfig
* Options used to configure credentials, including auth token caching, for the
* client. For a full list of supporting configuration options, see
* {@see \Google\ApiCore\CredentialsWrapper::build()} .
* @type bool $disableRetries
* Determines whether or not retries defined by the client configuration should be
* disabled. Defaults to `false`.
* @type string|array $clientConfig
* Client method configuration, including retry settings. This option can be either
* a path to a JSON file, or a PHP array containing the decoded JSON data. By
* default this settings points to the default client config file, which is
* provided in the resources folder.
* @type string|TransportInterface $transport
* The transport used for executing network requests. May be either the string
* `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system.
* *Advanced usage*: Additionally, it is possible to pass in an already
* instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note
* that when this object is provided, any settings in $transportConfig, and any
* $apiEndpoint setting, will be ignored.
* @type array $transportConfig
* Configuration options that will be used to construct the transport. Options for
* each supported transport type should be passed in a key for that transport. For
* example:
* $transportConfig = [
* 'grpc' => [...],
* 'rest' => [...],
* ];
* See the {@see \Google\ApiCore\Transport\GrpcTransport::build()} and
* {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the
* supported options.
* @type callable $clientCertSource
* A callable which returns the client cert as a string. This can be used to
* provide a certificate and private key to the transport layer for mTLS.
* @type false|LoggerInterface $logger
* A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
* 'GOOGLE_SDK_PHP_LOGGING' environment flag
* @type string $universeDomain
* The service domain for the client. Defaults to 'googleapis.com'.
* }
*
* @throws ValidationException
*/
public function __construct(array|ClientOptions $options = [])
{
$clientOptions = $this->buildClientOptions($options);
$this->setClientOptions($clientOptions);
$this->operationsClient = $this->createOperationsClient($clientOptions);
}
/** Handles execution of the async variants for each documented method. */
public function __call($method, $args)
{
if (substr($method, -5) !== 'Async') {
trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR);
}
array_unshift($args, substr($method, 0, -5));
return call_user_func_array([$this, 'startAsyncCall'], $args);
}
/**
* Creates a new managed service.
*
* A managed service is immutable, and is subject to mandatory 30-day
* data retention. You cannot move a service or recreate it within 30 days
* after deletion.
*
* One producer project can own no more than 500 services. For security and
* reliability purposes, a production service should be hosted in a
* dedicated producer project.
*
* Operation<response: ManagedService>
*
* The async variant is {@see ServiceManagerClient::createServiceAsync()} .
*
* @example samples/V1/ServiceManagerClient/create_service.php
*
* @param CreateServiceRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return OperationResponse<ManagedService>
*
* @throws ApiException Thrown if the API call fails.
*/
public function createService(CreateServiceRequest $request, array $callOptions = []): OperationResponse
{
return $this->startApiCall('CreateService', $request, $callOptions)->wait();
}
/**
* Creates a new service configuration (version) for a managed service.
* This method only stores the service configuration. To roll out the service
* configuration to backend systems please call
* [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].
*
* Only the 100 most recent service configurations and ones referenced by
* existing rollouts are kept for each service. The rest will be deleted
* eventually.
*
* The async variant is {@see ServiceManagerClient::createServiceConfigAsync()} .
*
* @example samples/V1/ServiceManagerClient/create_service_config.php
*
* @param CreateServiceConfigRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return Service
*
* @throws ApiException Thrown if the API call fails.
*/
public function createServiceConfig(CreateServiceConfigRequest $request, array $callOptions = []): Service
{
return $this->startApiCall('CreateServiceConfig', $request, $callOptions)->wait();
}
/**
* Creates a new service configuration rollout. Based on rollout, the
* Google Service Management will roll out the service configurations to
* different backend services. For example, the logging configuration will be
* pushed to Google Cloud Logging.
*
* Please note that any previous pending and running Rollouts and associated
* Operations will be automatically cancelled so that the latest Rollout will
* not be blocked by previous Rollouts.
*
* Only the 100 most recent (in any state) and the last 10 successful (if not
* already part of the set of 100 most recent) rollouts are kept for each
* service. The rest will be deleted eventually.
*
* Operation<response: Rollout>
*
* The async variant is {@see ServiceManagerClient::createServiceRolloutAsync()} .
*
* @example samples/V1/ServiceManagerClient/create_service_rollout.php
*
* @param CreateServiceRolloutRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return OperationResponse<Rollout>
*
* @throws ApiException Thrown if the API call fails.
*/
public function createServiceRollout(
CreateServiceRolloutRequest $request,
array $callOptions = []
): OperationResponse {
return $this->startApiCall('CreateServiceRollout', $request, $callOptions)->wait();
}
/**
* Deletes a managed service. This method will change the service to the
* `Soft-Delete` state for 30 days. Within this period, service producers may
* call
* [UndeleteService][google.api.servicemanagement.v1.ServiceManager.UndeleteService]
* to restore the service. After 30 days, the service will be permanently
* deleted.
*
* Operation<response: google.protobuf.Empty>
*
* The async variant is {@see ServiceManagerClient::deleteServiceAsync()} .
*
* @example samples/V1/ServiceManagerClient/delete_service.php
*
* @param DeleteServiceRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return OperationResponse<null>
*
* @throws ApiException Thrown if the API call fails.
*/
public function deleteService(DeleteServiceRequest $request, array $callOptions = []): OperationResponse
{
return $this->startApiCall('DeleteService', $request, $callOptions)->wait();
}
/**
* Generates and returns a report (errors, warnings and changes from
* existing configurations) associated with
* GenerateConfigReportRequest.new_value
*
* If GenerateConfigReportRequest.old_value is specified,
* GenerateConfigReportRequest will contain a single ChangeReport based on the
* comparison between GenerateConfigReportRequest.new_value and
* GenerateConfigReportRequest.old_value.
* If GenerateConfigReportRequest.old_value is not specified, this method
* will compare GenerateConfigReportRequest.new_value with the last pushed
* service configuration.
*
* The async variant is {@see ServiceManagerClient::generateConfigReportAsync()} .
*
* @example samples/V1/ServiceManagerClient/generate_config_report.php
*
* @param GenerateConfigReportRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return GenerateConfigReportResponse
*
* @throws ApiException Thrown if the API call fails.
*/
public function generateConfigReport(
GenerateConfigReportRequest $request,
array $callOptions = []
): GenerateConfigReportResponse {
return $this->startApiCall('GenerateConfigReport', $request, $callOptions)->wait();
}
/**
* Gets a managed service. Authentication is required unless the service is
* public.
*
* The async variant is {@see ServiceManagerClient::getServiceAsync()} .
*
* @example samples/V1/ServiceManagerClient/get_service.php
*
* @param GetServiceRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return ManagedService
*
* @throws ApiException Thrown if the API call fails.
*/
public function getService(GetServiceRequest $request, array $callOptions = []): ManagedService
{
return $this->startApiCall('GetService', $request, $callOptions)->wait();
}
/**
* Gets a service configuration (version) for a managed service.
*
* The async variant is {@see ServiceManagerClient::getServiceConfigAsync()} .
*
* @example samples/V1/ServiceManagerClient/get_service_config.php
*
* @param GetServiceConfigRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return Service
*
* @throws ApiException Thrown if the API call fails.
*/
public function getServiceConfig(GetServiceConfigRequest $request, array $callOptions = []): Service
{
return $this->startApiCall('GetServiceConfig', $request, $callOptions)->wait();
}
/**
* Gets a service configuration
* [rollout][google.api.servicemanagement.v1.Rollout].
*
* The async variant is {@see ServiceManagerClient::getServiceRolloutAsync()} .
*
* @example samples/V1/ServiceManagerClient/get_service_rollout.php
*
* @param GetServiceRolloutRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return Rollout
*
* @throws ApiException Thrown if the API call fails.
*/
public function getServiceRollout(GetServiceRolloutRequest $request, array $callOptions = []): Rollout
{
return $this->startApiCall('GetServiceRollout', $request, $callOptions)->wait();
}
/**
* Lists the history of the service configuration for a managed service,
* from the newest to the oldest.
*
* The async variant is {@see ServiceManagerClient::listServiceConfigsAsync()} .
*
* @example samples/V1/ServiceManagerClient/list_service_configs.php
*
* @param ListServiceConfigsRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return PagedListResponse
*
* @throws ApiException Thrown if the API call fails.
*/
public function listServiceConfigs(ListServiceConfigsRequest $request, array $callOptions = []): PagedListResponse
{
return $this->startApiCall('ListServiceConfigs', $request, $callOptions);
}
/**
* Lists the history of the service configuration rollouts for a managed
* service, from the newest to the oldest.
*
* The async variant is {@see ServiceManagerClient::listServiceRolloutsAsync()} .
*
* @example samples/V1/ServiceManagerClient/list_service_rollouts.php
*
* @param ListServiceRolloutsRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return PagedListResponse
*
* @throws ApiException Thrown if the API call fails.
*/
public function listServiceRollouts(ListServiceRolloutsRequest $request, array $callOptions = []): PagedListResponse
{
return $this->startApiCall('ListServiceRollouts', $request, $callOptions);
}
/**
* Lists managed services.
*
* Returns all public services. For authenticated users, also returns all
* services the calling user has "servicemanagement.services.get" permission
* for.
*
* The async variant is {@see ServiceManagerClient::listServicesAsync()} .
*
* @example samples/V1/ServiceManagerClient/list_services.php
*
* @param ListServicesRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return PagedListResponse
*
* @throws ApiException Thrown if the API call fails.
*/
public function listServices(ListServicesRequest $request, array $callOptions = []): PagedListResponse
{
return $this->startApiCall('ListServices', $request, $callOptions);
}
/**
* Creates a new service configuration (version) for a managed service based
* on
* user-supplied configuration source files (for example: OpenAPI
* Specification). This method stores the source configurations as well as the
* generated service configuration. To rollout the service configuration to
* other services,
* please call
* [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].
*
* Only the 100 most recent configuration sources and ones referenced by
* existing service configurtions are kept for each service. The rest will be
* deleted eventually.
*
* Operation<response: SubmitConfigSourceResponse>
*
* The async variant is {@see ServiceManagerClient::submitConfigSourceAsync()} .
*
* @example samples/V1/ServiceManagerClient/submit_config_source.php
*
* @param SubmitConfigSourceRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return OperationResponse<SubmitConfigSourceResponse>
*
* @throws ApiException Thrown if the API call fails.
*/
public function submitConfigSource(SubmitConfigSourceRequest $request, array $callOptions = []): OperationResponse
{
return $this->startApiCall('SubmitConfigSource', $request, $callOptions)->wait();
}
/**
* Revives a previously deleted managed service. The method restores the
* service using the configuration at the time the service was deleted.
* The target service must exist and must have been deleted within the
* last 30 days.
*
* Operation<response: UndeleteServiceResponse>
*
* The async variant is {@see ServiceManagerClient::undeleteServiceAsync()} .
*
* @example samples/V1/ServiceManagerClient/undelete_service.php
*
* @param UndeleteServiceRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return OperationResponse<UndeleteServiceResponse>
*
* @throws ApiException Thrown if the API call fails.
*/
public function undeleteService(UndeleteServiceRequest $request, array $callOptions = []): OperationResponse
{
return $this->startApiCall('UndeleteService', $request, $callOptions)->wait();
}
/**
* Gets the access control policy for a resource. Returns an empty policy
* if the resource exists and does not have a policy set.
*
* The async variant is {@see ServiceManagerClient::getIamPolicyAsync()} .
*
* @example samples/V1/ServiceManagerClient/get_iam_policy.php
*
* @param GetIamPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return Policy
*
* @throws ApiException Thrown if the API call fails.
*/
public function getIamPolicy(GetIamPolicyRequest $request, array $callOptions = []): Policy
{
return $this->startApiCall('GetIamPolicy', $request, $callOptions)->wait();
}
/**
* Sets the access control policy on the specified resource. Replaces
* any existing policy.
*
* Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
* errors.
*
* The async variant is {@see ServiceManagerClient::setIamPolicyAsync()} .
*
* @example samples/V1/ServiceManagerClient/set_iam_policy.php
*
* @param SetIamPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return Policy
*
* @throws ApiException Thrown if the API call fails.
*/
public function setIamPolicy(SetIamPolicyRequest $request, array $callOptions = []): Policy
{
return $this->startApiCall('SetIamPolicy', $request, $callOptions)->wait();
}
/**
* Returns permissions that a caller has on the specified resource. If the
* resource does not exist, this will return an empty set of
* permissions, not a `NOT_FOUND` error.
*
* Note: This operation is designed to be used for building
* permission-aware UIs and command-line tools, not for authorization
* checking. This operation may "fail open" without warning.
*
* The async variant is {@see ServiceManagerClient::testIamPermissionsAsync()} .
*
* @example samples/V1/ServiceManagerClient/test_iam_permissions.php
*
* @param TestIamPermissionsRequest $request A request to house fields associated with the call.
* @param array $callOptions {
* Optional.
*
* @type RetrySettings|array $retrySettings
* Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
* associative array of retry settings parameters. See the documentation on
* {@see RetrySettings} for example usage.
* }
*
* @return TestIamPermissionsResponse
*
* @throws ApiException Thrown if the API call fails.
*/
public function testIamPermissions(
TestIamPermissionsRequest $request,
array $callOptions = []
): TestIamPermissionsResponse {
return $this->startApiCall('TestIamPermissions', $request, $callOptions)->wait();
}
}