|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * Copyright 2025 Google Inc. |
| 4 | + * |
| 5 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | + * you may not use this file except in compliance with the License. |
| 7 | + * You may obtain a copy of 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, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | + |
| 18 | +namespace Google\Cloud\Core\LongRunning; |
| 19 | + |
| 20 | +use Google\ApiCore\OperationResponse; |
| 21 | +use Google\ApiCore\Serializer; |
| 22 | +use Google\Cloud\Core\RequestProcessorTrait; |
| 23 | +use Google\LongRunning\ListOperationsRequest; |
| 24 | +use Google\Protobuf\Any; |
| 25 | + |
| 26 | +/** |
| 27 | + * Defines the calls required to manage Long Running Operations using a GAPIC |
| 28 | + * generated client. |
| 29 | + * |
| 30 | + * @internal |
| 31 | + */ |
| 32 | +class LongRunningClientConnection implements LongRunningConnectionInterface |
| 33 | +{ |
| 34 | + use RequestProcessorTrait; |
| 35 | + |
| 36 | + public function __construct( |
| 37 | + private object $gapicClient, |
| 38 | + private Serializer $serializer |
| 39 | + ) { |
| 40 | + } |
| 41 | + |
| 42 | + /** |
| 43 | + * @param array $args |
| 44 | + * @return array |
| 45 | + */ |
| 46 | + public function get(array $args): array |
| 47 | + { |
| 48 | + $operationResponse = $this->gapicClient->resumeOperation($args['name']); |
| 49 | + |
| 50 | + return $this->operationResponseToArray($operationResponse); |
| 51 | + } |
| 52 | + |
| 53 | + /** |
| 54 | + * @param array $args |
| 55 | + * @return array |
| 56 | + */ |
| 57 | + public function cancel(array $args): array |
| 58 | + { |
| 59 | + $operationResponse = $this->gapicClient->resumeOperation( |
| 60 | + $args['name'], |
| 61 | + $args['method'] ?? null |
| 62 | + ); |
| 63 | + $operationResponse->cancel(); |
| 64 | + |
| 65 | + return $this->operationResponseToArray($operationResponse); |
| 66 | + } |
| 67 | + |
| 68 | + /** |
| 69 | + * @param array $args |
| 70 | + * @return array |
| 71 | + */ |
| 72 | + public function delete(array $args): array |
| 73 | + { |
| 74 | + $operationResponse = $this->gapicClient->resumeOperation( |
| 75 | + $args['name'], |
| 76 | + $args['method'] ?? null |
| 77 | + ); |
| 78 | + $operationResponse->cancel(); |
| 79 | + |
| 80 | + return $this->operationResponseToArray($operationResponse); |
| 81 | + } |
| 82 | + |
| 83 | + /** |
| 84 | + * @param array $args |
| 85 | + * @return array |
| 86 | + */ |
| 87 | + public function operations(array $args): array |
| 88 | + { |
| 89 | + $request = ListOperationsRequest::build($args['name'], $args['filter'] ?? null); |
| 90 | + $response = $this->gapicClient->getOperationsClient()->listOperations($request); |
| 91 | + |
| 92 | + return $this->handleResponse($response); |
| 93 | + } |
| 94 | + |
| 95 | + private function operationResponseToArray(OperationResponse $operationResponse): array |
| 96 | + { |
| 97 | + $response = $this->handleResponse($operationResponse->getLastProtoResponse()); |
| 98 | + $metaType = $response['metadata']['typeUrl']; |
| 99 | + |
| 100 | + // unpack result Any type |
| 101 | + $result = $operationResponse->getResult(); |
| 102 | + if ($result instanceof Any) { |
| 103 | + // For some reason we aren't doing this in GAX OperationResponse (but we should) |
| 104 | + $result = $result->unpack(); |
| 105 | + } |
| 106 | + $response['response'] = $this->handleResponse($result); |
| 107 | + |
| 108 | + // unpack error Any type |
| 109 | + $response['error'] = $this->handleResponse($operationResponse->getError()); |
| 110 | + |
| 111 | + $metadata = $operationResponse->getMetadata(); |
| 112 | + if ($metadata instanceof Any) { |
| 113 | + // For some reason we aren't doing this in GAX OperationResponse (but we should) |
| 114 | + $metadata = $metadata->unpack(); |
| 115 | + } |
| 116 | + $response['metadata'] = $this->handleResponse($metadata); |
| 117 | + |
| 118 | + // Used in LongRunningOperation to invoke callables |
| 119 | + $response['metadata'] += ['typeUrl' => $metaType]; |
| 120 | + |
| 121 | + return $response; |
| 122 | + } |
| 123 | +} |
0 commit comments