Skip to content

Commit

Permalink
docs: clarity and typo fixes for documentation (#7837)
Browse files Browse the repository at this point in the history
docs: fix example rpc naming

chore: add objective C packaging option
PiperOrigin-RevId: 696556327
Source-Link: googleapis/googleapis@0c5b3eb
Source-Link: googleapis/googleapis-gen@288b20d
Copy-Tag: eyJwIjoiTG9uZ1J1bm5pbmcvLk93bEJvdC55YW1sIiwiaCI6IjI4OGIyMGRiZmVhNDgyZjBlZWE5ZjBhZjc5NTkyZjBlZGIxZjRkOGQifQ==
  • Loading branch information
gcf-owl-bot[bot] authored Nov 15, 2024
1 parent 1ecd7e8 commit a91f524
Show file tree
Hide file tree
Showing 11 changed files with 39 additions and 48 deletions.
Binary file modified LongRunning/metadata/Longrunning/Operations.php
Binary file not shown.
3 changes: 2 additions & 1 deletion LongRunning/src/LongRunning/CancelOperationRequest.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 9 additions & 16 deletions LongRunning/src/LongRunning/Client/OperationsClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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()} .
*
Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion LongRunning/src/LongRunning/DeleteOperationRequest.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 9 additions & 16 deletions LongRunning/src/LongRunning/Gapic/OperationsGapicClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
* ```
Expand Down Expand Up @@ -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();
Expand Down
3 changes: 2 additions & 1 deletion LongRunning/src/LongRunning/GetOperationRequest.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion LongRunning/src/LongRunning/ListOperationsRequest.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion LongRunning/src/LongRunning/ListOperationsResponse.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions LongRunning/src/LongRunning/Operation.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 6 additions & 7 deletions LongRunning/src/LongRunning/OperationInfo.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion LongRunning/src/LongRunning/WaitOperationRequest.php

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a91f524

Please sign in to comment.