From a91f5247eb3c7ddd964e01a0a71dd00a6097824f Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 15 Nov 2024 15:48:32 -0500 Subject: [PATCH] docs: clarity and typo fixes for documentation (#7837) docs: fix example rpc naming chore: add objective C packaging option PiperOrigin-RevId: 696556327 Source-Link: https://github.com/googleapis/googleapis/commit/0c5b3eb0f7cca9630c4f160ed3e22a48eb7a36bb Source-Link: https://github.com/googleapis/googleapis-gen/commit/288b20dbfea482f0eea9f0af79592f0edb1f4d8d Copy-Tag: eyJwIjoiTG9uZ1J1bm5pbmcvLk93bEJvdC55YW1sIiwiaCI6IjI4OGIyMGRiZmVhNDgyZjBlZWE5ZjBhZjc5NTkyZjBlZGIxZjRkOGQifQ== --- .../metadata/Longrunning/Operations.php | Bin 2587 -> 2595 bytes .../LongRunning/CancelOperationRequest.php | 3 ++- .../LongRunning/Client/OperationsClient.php | 25 +++++++----------- .../LongRunning/DeleteOperationRequest.php | 3 ++- .../Gapic/OperationsGapicClient.php | 25 +++++++----------- .../src/LongRunning/GetOperationRequest.php | 3 ++- .../src/LongRunning/ListOperationsRequest.php | 3 ++- .../LongRunning/ListOperationsResponse.php | 3 ++- LongRunning/src/LongRunning/Operation.php | 6 ++--- LongRunning/src/LongRunning/OperationInfo.php | 13 +++++---- .../src/LongRunning/WaitOperationRequest.php | 3 ++- 11 files changed, 39 insertions(+), 48 deletions(-) diff --git a/LongRunning/metadata/Longrunning/Operations.php b/LongRunning/metadata/Longrunning/Operations.php index 2ed35d91878de9e1a9f899893fad9fbb1a18793b..0dcf976e506f6f99a6ff1bdd264cdb56e060d7ba 100644 GIT binary patch delta 45 zcmbO&vRGt;0yE?G$%@SRlbgoogle.longrunning.CancelOperationRequest */ diff --git a/LongRunning/src/LongRunning/Client/OperationsClient.php b/LongRunning/src/LongRunning/Client/OperationsClient.php index b49d58ed1ea9..2443891b00cc 100644 --- a/LongRunning/src/LongRunning/Client/OperationsClient.php +++ b/LongRunning/src/LongRunning/Client/OperationsClient.php @@ -44,12 +44,12 @@ * Service Description: Manages long-running operations with an API service. * * When an API method normally takes long time to complete, it can be designed - * to return [Operation][google.longrunning.Operation] to the client, and the client can use this - * interface to receive the real response asynchronously by polling the - * operation resource, or pass the operation resource to another API (such as - * Google Cloud Pub/Sub API) to receive the response. Any API service that - * returns long-running operations should implement the `Operations` interface - * so developers can have a consistent client experience. + * to return [Operation][google.longrunning.Operation] to the client, and the + * client can use this interface to receive the real response asynchronously by + * polling the operation resource, or pass the operation resource to another API + * (such as Pub/Sub API) to receive the response. Any API service that returns + * long-running operations should implement the `Operations` interface so + * developers can have a consistent client experience. * * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. @@ -185,8 +185,9 @@ public function __call($method, $args) * other methods to check whether the cancellation succeeded or whether the * operation completed despite cancellation. On successful cancellation, * the operation is not deleted; instead, it becomes an operation with - * an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, - * corresponding to `Code.CANCELLED`. + * an [Operation.error][google.longrunning.Operation.error] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of `1`, corresponding to + * `Code.CANCELLED`. * * The async variant is {@see OperationsClient::cancelOperationAsync()} . * @@ -268,14 +269,6 @@ public function getOperation(GetOperationRequest $request, array $callOptions = * Lists operations that match the specified filter in the request. If the * server doesn't support this method, it returns `UNIMPLEMENTED`. * - * NOTE: the `name` binding allows API services to override the binding - * to use different resource name schemes, such as `users/*/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/*}/operations"` to their service configuration. - * For backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding - * is the parent resource, without the operations collection id. - * * The async variant is {@see OperationsClient::listOperationsAsync()} . * * @example samples/OperationsClient/list_operations.php diff --git a/LongRunning/src/LongRunning/DeleteOperationRequest.php b/LongRunning/src/LongRunning/DeleteOperationRequest.php index 943a6498c743..c79382a224fa 100644 --- a/LongRunning/src/LongRunning/DeleteOperationRequest.php +++ b/LongRunning/src/LongRunning/DeleteOperationRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation]. + * The request message for + * [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation]. * * Generated from protobuf message google.longrunning.DeleteOperationRequest */ diff --git a/LongRunning/src/LongRunning/Gapic/OperationsGapicClient.php b/LongRunning/src/LongRunning/Gapic/OperationsGapicClient.php index c0de812aef7a..3c31a4fdad62 100644 --- a/LongRunning/src/LongRunning/Gapic/OperationsGapicClient.php +++ b/LongRunning/src/LongRunning/Gapic/OperationsGapicClient.php @@ -46,12 +46,12 @@ * Service Description: Manages long-running operations with an API service. * * When an API method normally takes long time to complete, it can be designed - * to return [Operation][google.longrunning.Operation] to the client, and the client can use this - * interface to receive the real response asynchronously by polling the - * operation resource, or pass the operation resource to another API (such as - * Google Cloud Pub/Sub API) to receive the response. Any API service that - * returns long-running operations should implement the `Operations` interface - * so developers can have a consistent client experience. + * to return [Operation][google.longrunning.Operation] to the client, and the + * client can use this interface to receive the real response asynchronously by + * polling the operation resource, or pass the operation resource to another API + * (such as Pub/Sub API) to receive the response. Any API service that returns + * long-running operations should implement the `Operations` interface so + * developers can have a consistent client experience. * * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. Sample code to get started: @@ -188,8 +188,9 @@ public function __construct(array $options = []) * other methods to check whether the cancellation succeeded or whether the * operation completed despite cancellation. On successful cancellation, * the operation is not deleted; instead, it becomes an operation with - * an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, - * corresponding to `Code.CANCELLED`. + * an [Operation.error][google.longrunning.Operation.error] value with a + * [google.rpc.Status.code][google.rpc.Status.code] of `1`, corresponding to + * `Code.CANCELLED`. * * Sample code: * ``` @@ -337,14 +338,6 @@ public function getOperation($name, array $optionalArgs = []) * Lists operations that match the specified filter in the request. If the * server doesn't support this method, it returns `UNIMPLEMENTED`. * - * NOTE: the `name` binding allows API services to override the binding - * to use different resource name schemes, such as `users/*/operations`. To - * override the binding, API services can add a binding such as - * `"/v1/{name=users/*}/operations"` to their service configuration. - * For backwards compatibility, the default name includes the operations - * collection id, however overriding users must ensure the name binding - * is the parent resource, without the operations collection id. - * * Sample code: * ``` * $operationsClient = new OperationsClient(); diff --git a/LongRunning/src/LongRunning/GetOperationRequest.php b/LongRunning/src/LongRunning/GetOperationRequest.php index d89d75cc6240..1fa48a5cf6cf 100644 --- a/LongRunning/src/LongRunning/GetOperationRequest.php +++ b/LongRunning/src/LongRunning/GetOperationRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation]. + * The request message for + * [Operations.GetOperation][google.longrunning.Operations.GetOperation]. * * Generated from protobuf message google.longrunning.GetOperationRequest */ diff --git a/LongRunning/src/LongRunning/ListOperationsRequest.php b/LongRunning/src/LongRunning/ListOperationsRequest.php index 3ad0bebe826d..08049d24845e 100644 --- a/LongRunning/src/LongRunning/ListOperationsRequest.php +++ b/LongRunning/src/LongRunning/ListOperationsRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations]. + * The request message for + * [Operations.ListOperations][google.longrunning.Operations.ListOperations]. * * Generated from protobuf message google.longrunning.ListOperationsRequest */ diff --git a/LongRunning/src/LongRunning/ListOperationsResponse.php b/LongRunning/src/LongRunning/ListOperationsResponse.php index 8da087dd242d..4fd271861c5d 100644 --- a/LongRunning/src/LongRunning/ListOperationsResponse.php +++ b/LongRunning/src/LongRunning/ListOperationsResponse.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations]. + * The response message for + * [Operations.ListOperations][google.longrunning.Operations.ListOperations]. * * Generated from protobuf message google.longrunning.ListOperationsResponse */ diff --git a/LongRunning/src/LongRunning/Operation.php b/LongRunning/src/LongRunning/Operation.php index 81f856c36a8b..e8fec9e656ee 100644 --- a/LongRunning/src/LongRunning/Operation.php +++ b/LongRunning/src/LongRunning/Operation.php @@ -65,7 +65,7 @@ class Operation extends \Google\Protobuf\Internal\Message * @type \Google\Rpc\Status $error * The error result of the operation in case of failure or cancellation. * @type \Google\Protobuf\Any $response - * The normal response of the operation in case of success. If the original + * The normal, successful response of the operation. If the original * method returns no data on success, such as `Delete`, the response is * `google.protobuf.Empty`. If the original method is standard * `Get`/`Create`/`Update`, the response should be the resource. For other @@ -214,7 +214,7 @@ public function setError($var) } /** - * The normal response of the operation in case of success. If the original + * The normal, successful response of the operation. If the original * method returns no data on success, such as `Delete`, the response is * `google.protobuf.Empty`. If the original method is standard * `Get`/`Create`/`Update`, the response should be the resource. For other @@ -237,7 +237,7 @@ public function hasResponse() } /** - * The normal response of the operation in case of success. If the original + * The normal, successful response of the operation. If the original * method returns no data on success, such as `Delete`, the response is * `google.protobuf.Empty`. If the original method is standard * `Get`/`Create`/`Update`, the response should be the resource. For other diff --git a/LongRunning/src/LongRunning/OperationInfo.php b/LongRunning/src/LongRunning/OperationInfo.php index 35ebb15b551a..c6533199a79a 100644 --- a/LongRunning/src/LongRunning/OperationInfo.php +++ b/LongRunning/src/LongRunning/OperationInfo.php @@ -11,13 +11,12 @@ /** * A message representing the message types used by a long-running operation. * Example: - * rpc LongRunningRecognize(LongRunningRecognizeRequest) - * returns (google.longrunning.Operation) { - * option (google.longrunning.operation_info) = { - * response_type: "LongRunningRecognizeResponse" - * metadata_type: "LongRunningRecognizeMetadata" - * }; - * } + * rpc Export(ExportRequest) returns (google.longrunning.Operation) { + * option (google.longrunning.operation_info) = { + * response_type: "ExportResponse" + * metadata_type: "ExportMetadata" + * }; + * } * * Generated from protobuf message google.longrunning.OperationInfo */ diff --git a/LongRunning/src/LongRunning/WaitOperationRequest.php b/LongRunning/src/LongRunning/WaitOperationRequest.php index 7da6bc734e9e..07914090b55f 100644 --- a/LongRunning/src/LongRunning/WaitOperationRequest.php +++ b/LongRunning/src/LongRunning/WaitOperationRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation]. + * The request message for + * [Operations.WaitOperation][google.longrunning.Operations.WaitOperation]. * * Generated from protobuf message google.longrunning.WaitOperationRequest */