Skip to content

Commit d4c6cb0

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
chore(docs): improved phpdoc for clients
PiperOrigin-RevId: 539726243 Source-Link: googleapis/googleapis@277df0e Source-Link: googleapis/googleapis-gen@e7ec1f4 Copy-Tag: eyJwIjoiQmV5b25kQ29ycEFwcEdhdGV3YXlzLy5Pd2xCb3QueWFtbCIsImgiOiJlN2VjMWY0Nzg4ZTYyOGM2ODZkZmU0YjUwOTZiZDQ4OTRjMGNjNTRjIn0= Copy-Tag: eyJwIjoiQmV5b25kQ29ycENsaWVudENvbm5lY3RvclNlcnZpY2VzLy5Pd2xCb3QueWFtbCIsImgiOiJlN2VjMWY0Nzg4ZTYyOGM2ODZkZmU0YjUwOTZiZDQ4OTRjMGNjNTRjIn0= Copy-Tag: eyJwIjoiQmV5b25kQ29ycENsaWVudEdhdGV3YXlzLy5Pd2xCb3QueWFtbCIsImgiOiJlN2VjMWY0Nzg4ZTYyOGM2ODZkZmU0YjUwOTZiZDQ4OTRjMGNjNTRjIn0= Copy-Tag: eyJwIjoiQmlnUXVlcnlBbmFseXRpY3NIdWIvLk93bEJvdC55YW1sIiwiaCI6ImU3ZWMxZjQ3ODhlNjI4YzY4NmRmZTRiNTA5NmJkNDg5NGMwY2M1NGMifQ== Copy-Tag: eyJwIjoiQmlnUXVlcnlDb25uZWN0aW9uLy5Pd2xCb3QueWFtbCIsImgiOiJlN2VjMWY0Nzg4ZTYyOGM2ODZkZmU0YjUwOTZiZDQ4OTRjMGNjNTRjIn0= Copy-Tag: eyJwIjoiQmlnUXVlcnlEYXRhRXhjaGFuZ2UvLk93bEJvdC55YW1sIiwiaCI6ImU3ZWMxZjQ3ODhlNjI4YzY4NmRmZTRiNTA5NmJkNDg5NGMwY2M1NGMifQ== Copy-Tag: eyJwIjoiQmlnUXVlcnlEYXRhUG9saWNpZXMvLk93bEJvdC55YW1sIiwiaCI6ImU3ZWMxZjQ3ODhlNjI4YzY4NmRmZTRiNTA5NmJkNDg5NGMwY2M1NGMifQ== Copy-Tag: eyJwIjoiQmlnUXVlcnlEYXRhVHJhbnNmZXIvLk93bEJvdC55YW1sIiwiaCI6ImU3ZWMxZjQ3ODhlNjI4YzY4NmRmZTRiNTA5NmJkNDg5NGMwY2M1NGMifQ== Copy-Tag: eyJwIjoiQmlnUXVlcnlNaWdyYXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImU3ZWMxZjQ3ODhlNjI4YzY4NmRmZTRiNTA5NmJkNDg5NGMwY2M1NGMifQ== Copy-Tag: eyJwIjoiQmlnUXVlcnlSZXNlcnZhdGlvbi8uT3dsQm90LnlhbWwiLCJoIjoiZTdlYzFmNDc4OGU2MjhjNjg2ZGZlNGI1MDk2YmQ0ODk0YzBjYzU0YyJ9 Copy-Tag: eyJwIjoiQmlnUXVlcnlTdG9yYWdlLy5Pd2xCb3QueWFtbCIsImgiOiJlN2VjMWY0Nzg4ZTYyOGM2ODZkZmU0YjUwOTZiZDQ4OTRjMGNjNTRjIn0= Copy-Tag: eyJwIjoiQmlndGFibGUvLk93bEJvdC55YW1sIiwiaCI6ImU3ZWMxZjQ3ODhlNjI4YzY4NmRmZTRiNTA5NmJkNDg5NGMwY2M1NGMifQ== Copy-Tag: eyJwIjoiQmlsbGluZy8uT3dsQm90LnlhbWwiLCJoIjoiZTdlYzFmNDc4OGU2MjhjNjg2ZGZlNGI1MDk2YmQ0ODk0YzBjYzU0YyJ9 Copy-Tag: eyJwIjoiQmlsbGluZ0J1ZGdldHMvLk93bEJvdC55YW1sIiwiaCI6ImU3ZWMxZjQ3ODhlNjI4YzY4NmRmZTRiNTA5NmJkNDg5NGMwY2M1NGMifQ== Copy-Tag: eyJwIjoiQmluYXJ5QXV0aG9yaXphdGlvbi8uT3dsQm90LnlhbWwiLCJoIjoiZTdlYzFmNDc4OGU2MjhjNjg2ZGZlNGI1MDk2YmQ0ODk0YzBjYzU0YyJ9 Copy-Tag: eyJwIjoiQnVpbGQvLk93bEJvdC55YW1sIiwiaCI6ImU3ZWMxZjQ3ODhlNjI4YzY4NmRmZTRiNTA5NmJkNDg5NGMwY2M1NGMifQ== Copy-Tag: eyJwIjoiQ2VydGlmaWNhdGVNYW5hZ2VyLy5Pd2xCb3QueWFtbCIsImgiOiJlN2VjMWY0Nzg4ZTYyOGM2ODZkZmU0YjUwOTZiZDQ4OTRjMGNjNTRjIn0= Copy-Tag: eyJwIjoiQ2hhbm5lbC8uT3dsQm90LnlhbWwiLCJoIjoiZTdlYzFmNDc4OGU2MjhjNjg2ZGZlNGI1MDk2YmQ0ODk0YzBjYzU0YyJ9 Copy-Tag: eyJwIjoiQ29tcHV0ZS8uT3dsQm90LnlhbWwiLCJoIjoiZTdlYzFmNDc4OGU2MjhjNjg2ZGZlNGI1MDk2YmQ0ODk0YzBjYzU0YyJ9 Copy-Tag: eyJwIjoiQ29uZmlkZW50aWFsQ29tcHV0aW5nLy5Pd2xCb3QueWFtbCIsImgiOiJlN2VjMWY0Nzg4ZTYyOGM2ODZkZmU0YjUwOTZiZDQ4OTRjMGNjNTRjIn0=
1 parent c6fd145 commit d4c6cb0

227 files changed

Lines changed: 913 additions & 111 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎BeyondCorpAppGateways/src/V1/Client/BaseClient/AppGatewaysServiceBaseClient.php‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,9 @@
7575
* name, and additionally a parseName method to extract the individual identifiers
7676
* contained within formatted names that are returned by the API.
7777
*
78-
* This class is currently experimental and may be subject to changes.
78+
* This class is currently experimental and may be subject to changes. See {@see
79+
* \Google\Cloud\BeyondCorp\AppGateways\V1\AppGatewaysServiceClient} for the stable
80+
* implementation
7981
*
8082
* @experimental
8183
*
@@ -301,6 +303,8 @@ public function __call($method, $args)
301303
*
302304
* The async variant is {@see self::createAppGatewayAsync()} .
303305
*
306+
* @example samples/V1/AppGatewaysServiceClient/create_app_gateway.php
307+
*
304308
* @param CreateAppGatewayRequest $request A request to house fields associated with the call.
305309
* @param array $callOptions {
306310
* Optional.
@@ -325,6 +329,8 @@ public function createAppGateway(CreateAppGatewayRequest $request, array $callOp
325329
*
326330
* The async variant is {@see self::deleteAppGatewayAsync()} .
327331
*
332+
* @example samples/V1/AppGatewaysServiceClient/delete_app_gateway.php
333+
*
328334
* @param DeleteAppGatewayRequest $request A request to house fields associated with the call.
329335
* @param array $callOptions {
330336
* Optional.
@@ -349,6 +355,8 @@ public function deleteAppGateway(DeleteAppGatewayRequest $request, array $callOp
349355
*
350356
* The async variant is {@see self::getAppGatewayAsync()} .
351357
*
358+
* @example samples/V1/AppGatewaysServiceClient/get_app_gateway.php
359+
*
352360
* @param GetAppGatewayRequest $request A request to house fields associated with the call.
353361
* @param array $callOptions {
354362
* Optional.
@@ -373,6 +381,8 @@ public function getAppGateway(GetAppGatewayRequest $request, array $callOptions
373381
*
374382
* The async variant is {@see self::listAppGatewaysAsync()} .
375383
*
384+
* @example samples/V1/AppGatewaysServiceClient/list_app_gateways.php
385+
*
376386
* @param ListAppGatewaysRequest $request A request to house fields associated with the call.
377387
* @param array $callOptions {
378388
* Optional.
@@ -397,6 +407,8 @@ public function listAppGateways(ListAppGatewaysRequest $request, array $callOpti
397407
*
398408
* The async variant is {@see self::getLocationAsync()} .
399409
*
410+
* @example samples/V1/AppGatewaysServiceClient/get_location.php
411+
*
400412
* @param GetLocationRequest $request A request to house fields associated with the call.
401413
* @param array $callOptions {
402414
* Optional.
@@ -421,6 +433,8 @@ public function getLocation(GetLocationRequest $request, array $callOptions = []
421433
*
422434
* The async variant is {@see self::listLocationsAsync()} .
423435
*
436+
* @example samples/V1/AppGatewaysServiceClient/list_locations.php
437+
*
424438
* @param ListLocationsRequest $request A request to house fields associated with the call.
425439
* @param array $callOptions {
426440
* Optional.
@@ -446,6 +460,8 @@ public function listLocations(ListLocationsRequest $request, array $callOptions
446460
*
447461
* The async variant is {@see self::getIamPolicyAsync()} .
448462
*
463+
* @example samples/V1/AppGatewaysServiceClient/get_iam_policy.php
464+
*
449465
* @param GetIamPolicyRequest $request A request to house fields associated with the call.
450466
* @param array $callOptions {
451467
* Optional.
@@ -474,6 +490,8 @@ public function getIamPolicy(GetIamPolicyRequest $request, array $callOptions =
474490
*
475491
* The async variant is {@see self::setIamPolicyAsync()} .
476492
*
493+
* @example samples/V1/AppGatewaysServiceClient/set_iam_policy.php
494+
*
477495
* @param SetIamPolicyRequest $request A request to house fields associated with the call.
478496
* @param array $callOptions {
479497
* Optional.
@@ -504,6 +522,8 @@ public function setIamPolicy(SetIamPolicyRequest $request, array $callOptions =
504522
*
505523
* The async variant is {@see self::testIamPermissionsAsync()} .
506524
*
525+
* @example samples/V1/AppGatewaysServiceClient/test_iam_permissions.php
526+
*
507527
* @param TestIamPermissionsRequest $request A request to house fields associated with the call.
508528
* @param array $callOptions {
509529
* Optional.

‎BeyondCorpAppGateways/src/V1/Gapic/AppGatewaysServiceGapicClient.php‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,10 @@
114114
* assist with these names, this class includes a format method for each type of
115115
* name, and additionally a parseName method to extract the individual identifiers
116116
* contained within formatted names that are returned by the API.
117+
*
118+
* This service has a new (beta) implementation. See {@see
119+
* \Google\Cloud\BeyondCorp\AppGateways\V1\Client\AppGatewaysServiceClient} to use
120+
* the new surface.
117121
*/
118122
class AppGatewaysServiceGapicClient
119123
{

‎BeyondCorpClientConnectorServices/src/V1/Client/BaseClient/ClientConnectorServicesServiceBaseClient.php‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,9 @@
7373
* name, and additionally a parseName method to extract the individual identifiers
7474
* contained within formatted names that are returned by the API.
7575
*
76-
* This class is currently experimental and may be subject to changes.
76+
* This class is currently experimental and may be subject to changes. See {@see
77+
* \Google\Cloud\BeyondCorp\ClientConnectorServices\V1\ClientConnectorServicesServiceClient}
78+
* for the stable implementation
7779
*
7880
* @experimental
7981
*
@@ -300,6 +302,8 @@ public function __call($method, $args)
300302
*
301303
* The async variant is {@see self::createClientConnectorServiceAsync()} .
302304
*
305+
* @example samples/V1/ClientConnectorServicesServiceClient/create_client_connector_service.php
306+
*
303307
* @param CreateClientConnectorServiceRequest $request A request to house fields associated with the call.
304308
* @param array $callOptions {
305309
* Optional.
@@ -324,6 +328,8 @@ public function createClientConnectorService(CreateClientConnectorServiceRequest
324328
*
325329
* The async variant is {@see self::deleteClientConnectorServiceAsync()} .
326330
*
331+
* @example samples/V1/ClientConnectorServicesServiceClient/delete_client_connector_service.php
332+
*
327333
* @param DeleteClientConnectorServiceRequest $request A request to house fields associated with the call.
328334
* @param array $callOptions {
329335
* Optional.
@@ -348,6 +354,8 @@ public function deleteClientConnectorService(DeleteClientConnectorServiceRequest
348354
*
349355
* The async variant is {@see self::getClientConnectorServiceAsync()} .
350356
*
357+
* @example samples/V1/ClientConnectorServicesServiceClient/get_client_connector_service.php
358+
*
351359
* @param GetClientConnectorServiceRequest $request A request to house fields associated with the call.
352360
* @param array $callOptions {
353361
* Optional.
@@ -372,6 +380,8 @@ public function getClientConnectorService(GetClientConnectorServiceRequest $requ
372380
*
373381
* The async variant is {@see self::listClientConnectorServicesAsync()} .
374382
*
383+
* @example samples/V1/ClientConnectorServicesServiceClient/list_client_connector_services.php
384+
*
375385
* @param ListClientConnectorServicesRequest $request A request to house fields associated with the call.
376386
* @param array $callOptions {
377387
* Optional.
@@ -396,6 +406,8 @@ public function listClientConnectorServices(ListClientConnectorServicesRequest $
396406
*
397407
* The async variant is {@see self::updateClientConnectorServiceAsync()} .
398408
*
409+
* @example samples/V1/ClientConnectorServicesServiceClient/update_client_connector_service.php
410+
*
399411
* @param UpdateClientConnectorServiceRequest $request A request to house fields associated with the call.
400412
* @param array $callOptions {
401413
* Optional.
@@ -420,6 +432,8 @@ public function updateClientConnectorService(UpdateClientConnectorServiceRequest
420432
*
421433
* The async variant is {@see self::getLocationAsync()} .
422434
*
435+
* @example samples/V1/ClientConnectorServicesServiceClient/get_location.php
436+
*
423437
* @param GetLocationRequest $request A request to house fields associated with the call.
424438
* @param array $callOptions {
425439
* Optional.
@@ -444,6 +458,8 @@ public function getLocation(GetLocationRequest $request, array $callOptions = []
444458
*
445459
* The async variant is {@see self::listLocationsAsync()} .
446460
*
461+
* @example samples/V1/ClientConnectorServicesServiceClient/list_locations.php
462+
*
447463
* @param ListLocationsRequest $request A request to house fields associated with the call.
448464
* @param array $callOptions {
449465
* Optional.
@@ -469,6 +485,8 @@ public function listLocations(ListLocationsRequest $request, array $callOptions
469485
*
470486
* The async variant is {@see self::getIamPolicyAsync()} .
471487
*
488+
* @example samples/V1/ClientConnectorServicesServiceClient/get_iam_policy.php
489+
*
472490
* @param GetIamPolicyRequest $request A request to house fields associated with the call.
473491
* @param array $callOptions {
474492
* Optional.
@@ -497,6 +515,8 @@ public function getIamPolicy(GetIamPolicyRequest $request, array $callOptions =
497515
*
498516
* The async variant is {@see self::setIamPolicyAsync()} .
499517
*
518+
* @example samples/V1/ClientConnectorServicesServiceClient/set_iam_policy.php
519+
*
500520
* @param SetIamPolicyRequest $request A request to house fields associated with the call.
501521
* @param array $callOptions {
502522
* Optional.
@@ -527,6 +547,8 @@ public function setIamPolicy(SetIamPolicyRequest $request, array $callOptions =
527547
*
528548
* The async variant is {@see self::testIamPermissionsAsync()} .
529549
*
550+
* @example samples/V1/ClientConnectorServicesServiceClient/test_iam_permissions.php
551+
*
530552
* @param TestIamPermissionsRequest $request A request to house fields associated with the call.
531553
* @param array $callOptions {
532554
* Optional.

‎BeyondCorpClientConnectorServices/src/V1/Gapic/ClientConnectorServicesServiceGapicClient.php‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,10 @@
112112
* assist with these names, this class includes a format method for each type of
113113
* name, and additionally a parseName method to extract the individual identifiers
114114
* contained within formatted names that are returned by the API.
115+
*
116+
* This service has a new (beta) implementation. See {@see
117+
* \Google\Cloud\BeyondCorp\ClientConnectorServices\V1\Client\ClientConnectorServicesServiceClient}
118+
* to use the new surface.
115119
*/
116120
class ClientConnectorServicesServiceGapicClient
117121
{

‎BeyondCorpClientGateways/src/V1/Client/BaseClient/ClientGatewaysServiceBaseClient.php‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,9 @@
7272
* name, and additionally a parseName method to extract the individual identifiers
7373
* contained within formatted names that are returned by the API.
7474
*
75-
* This class is currently experimental and may be subject to changes.
75+
* This class is currently experimental and may be subject to changes. See {@see
76+
* \Google\Cloud\BeyondCorp\ClientGateways\V1\ClientGatewaysServiceClient} for the
77+
* stable implementation
7678
*
7779
* @experimental
7880
*
@@ -298,6 +300,8 @@ public function __call($method, $args)
298300
*
299301
* The async variant is {@see self::createClientGatewayAsync()} .
300302
*
303+
* @example samples/V1/ClientGatewaysServiceClient/create_client_gateway.php
304+
*
301305
* @param CreateClientGatewayRequest $request A request to house fields associated with the call.
302306
* @param array $callOptions {
303307
* Optional.
@@ -322,6 +326,8 @@ public function createClientGateway(CreateClientGatewayRequest $request, array $
322326
*
323327
* The async variant is {@see self::deleteClientGatewayAsync()} .
324328
*
329+
* @example samples/V1/ClientGatewaysServiceClient/delete_client_gateway.php
330+
*
325331
* @param DeleteClientGatewayRequest $request A request to house fields associated with the call.
326332
* @param array $callOptions {
327333
* Optional.
@@ -346,6 +352,8 @@ public function deleteClientGateway(DeleteClientGatewayRequest $request, array $
346352
*
347353
* The async variant is {@see self::getClientGatewayAsync()} .
348354
*
355+
* @example samples/V1/ClientGatewaysServiceClient/get_client_gateway.php
356+
*
349357
* @param GetClientGatewayRequest $request A request to house fields associated with the call.
350358
* @param array $callOptions {
351359
* Optional.
@@ -370,6 +378,8 @@ public function getClientGateway(GetClientGatewayRequest $request, array $callOp
370378
*
371379
* The async variant is {@see self::listClientGatewaysAsync()} .
372380
*
381+
* @example samples/V1/ClientGatewaysServiceClient/list_client_gateways.php
382+
*
373383
* @param ListClientGatewaysRequest $request A request to house fields associated with the call.
374384
* @param array $callOptions {
375385
* Optional.
@@ -394,6 +404,8 @@ public function listClientGateways(ListClientGatewaysRequest $request, array $ca
394404
*
395405
* The async variant is {@see self::getLocationAsync()} .
396406
*
407+
* @example samples/V1/ClientGatewaysServiceClient/get_location.php
408+
*
397409
* @param GetLocationRequest $request A request to house fields associated with the call.
398410
* @param array $callOptions {
399411
* Optional.
@@ -418,6 +430,8 @@ public function getLocation(GetLocationRequest $request, array $callOptions = []
418430
*
419431
* The async variant is {@see self::listLocationsAsync()} .
420432
*
433+
* @example samples/V1/ClientGatewaysServiceClient/list_locations.php
434+
*
421435
* @param ListLocationsRequest $request A request to house fields associated with the call.
422436
* @param array $callOptions {
423437
* Optional.
@@ -443,6 +457,8 @@ public function listLocations(ListLocationsRequest $request, array $callOptions
443457
*
444458
* The async variant is {@see self::getIamPolicyAsync()} .
445459
*
460+
* @example samples/V1/ClientGatewaysServiceClient/get_iam_policy.php
461+
*
446462
* @param GetIamPolicyRequest $request A request to house fields associated with the call.
447463
* @param array $callOptions {
448464
* Optional.
@@ -471,6 +487,8 @@ public function getIamPolicy(GetIamPolicyRequest $request, array $callOptions =
471487
*
472488
* The async variant is {@see self::setIamPolicyAsync()} .
473489
*
490+
* @example samples/V1/ClientGatewaysServiceClient/set_iam_policy.php
491+
*
474492
* @param SetIamPolicyRequest $request A request to house fields associated with the call.
475493
* @param array $callOptions {
476494
* Optional.
@@ -501,6 +519,8 @@ public function setIamPolicy(SetIamPolicyRequest $request, array $callOptions =
501519
*
502520
* The async variant is {@see self::testIamPermissionsAsync()} .
503521
*
522+
* @example samples/V1/ClientGatewaysServiceClient/test_iam_permissions.php
523+
*
504524
* @param TestIamPermissionsRequest $request A request to house fields associated with the call.
505525
* @param array $callOptions {
506526
* Optional.

‎BeyondCorpClientGateways/src/V1/Gapic/ClientGatewaysServiceGapicClient.php‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,10 @@
111111
* assist with these names, this class includes a format method for each type of
112112
* name, and additionally a parseName method to extract the individual identifiers
113113
* contained within formatted names that are returned by the API.
114+
*
115+
* This service has a new (beta) implementation. See {@see
116+
* \Google\Cloud\BeyondCorp\ClientGateways\V1\Client\ClientGatewaysServiceClient}
117+
* to use the new surface.
114118
*/
115119
class ClientGatewaysServiceGapicClient
116120
{

0 commit comments

Comments
 (0)