Skip to content

Commit

Permalink
chore(docs): fix phpdoc references for async methods (#6711)
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 573309290
Source-Link: googleapis/googleapis@e3bd09d
Source-Link: https://github.com/googleapis/googleapis-gen/commit/8a144f4985f9f58022ec62b377a629fba3495ba1
Copy-Tag: eyJwIjoiQ29uZmlkZW50aWFsQ29tcHV0aW5nLy5Pd2xCb3QueWFtbCIsImgiOiI4YTE0NGY0OTg1ZjlmNTgwMjJlYzYyYjM3N2E2MjlmYmEzNDk1YmExIn0=
Copy-Tag: eyJwIjoiQ29uZmlnLy5Pd2xCb3QueWFtbCIsImgiOiI4YTE0NGY0OTg1ZjlmNTgwMjJlYzYyYjM3N2E2MjlmYmEzNDk1YmExIn0=
Copy-Tag: eyJwIjoiQ29udGFjdENlbnRlckluc2lnaHRzLy5Pd2xCb3QueWFtbCIsImgiOiI4YTE0NGY0OTg1ZjlmNTgwMjJlYzYyYjM3N2E2MjlmYmEzNDk1YmExIn0=
Copy-Tag: eyJwIjoiQ29udGFpbmVyLy5Pd2xCb3QueWFtbCIsImgiOiI4YTE0NGY0OTg1ZjlmNTgwMjJlYzYyYjM3N2E2MjlmYmEzNDk1YmExIn0=
Copy-Tag: eyJwIjoiQ29udGFpbmVyQW5hbHlzaXMvLk93bEJvdC55YW1sIiwiaCI6IjhhMTQ0ZjQ5ODVmOWY1ODAyMmVjNjJiMzc3YTYyOWZiYTM0OTViYTEifQ==
Copy-Tag: eyJwIjoiRGF0YUNhdGFsb2cvLk93bEJvdC55YW1sIiwiaCI6IjhhMTQ0ZjQ5ODVmOWY1ODAyMmVjNjJiMzc3YTYyOWZiYTM0OTViYTEifQ==
Copy-Tag: eyJwIjoiRGF0YUNhdGFsb2dMaW5lYWdlLy5Pd2xCb3QueWFtbCIsImgiOiI4YTE0NGY0OTg1ZjlmNTgwMjJlYzYyYjM3N2E2MjlmYmEzNDk1YmExIn0=
Copy-Tag: eyJwIjoiRGF0YUZ1c2lvbi8uT3dsQm90LnlhbWwiLCJoIjoiOGExNDRmNDk4NWY5ZjU4MDIyZWM2MmIzNzdhNjI5ZmJhMzQ5NWJhMSJ9
Copy-Tag: eyJwIjoiRGF0YUxhYmVsaW5nLy5Pd2xCb3QueWFtbCIsImgiOiI4YTE0NGY0OTg1ZjlmNTgwMjJlYzYyYjM3N2E2MjlmYmEzNDk1YmExIn0=
Copy-Tag: eyJwIjoiRGF0YWZsb3cvLk93bEJvdC55YW1sIiwiaCI6IjhhMTQ0ZjQ5ODVmOWY1ODAyMmVjNjJiMzc3YTYyOWZiYTM0OTViYTEifQ==
Copy-Tag: eyJwIjoiRGF0YWZvcm0vLk93bEJvdC55YW1sIiwiaCI6IjhhMTQ0ZjQ5ODVmOWY1ODAyMmVjNjJiMzc3YTYyOWZiYTM0OTViYTEifQ==
Copy-Tag: eyJwIjoiRGF0YXBsZXgvLk93bEJvdC55YW1sIiwiaCI6IjhhMTQ0ZjQ5ODVmOWY1ODAyMmVjNjJiMzc3YTYyOWZiYTM0OTViYTEifQ==
Copy-Tag: eyJwIjoiRGF0YXByb2MvLk93bEJvdC55YW1sIiwiaCI6IjhhMTQ0ZjQ5ODVmOWY1ODAyMmVjNjJiMzc3YTYyOWZiYTM0OTViYTEifQ==
Copy-Tag: eyJwIjoiRGF0YXByb2NNZXRhc3RvcmUvLk93bEJvdC55YW1sIiwiaCI6IjhhMTQ0ZjQ5ODVmOWY1ODAyMmVjNjJiMzc3YTYyOWZiYTM0OTViYTEifQ==
Copy-Tag: eyJwIjoiRGF0YXN0b3JlLy5Pd2xCb3QueWFtbCIsImgiOiI4YTE0NGY0OTg1ZjlmNTgwMjJlYzYyYjM3N2E2MjlmYmEzNDk1YmExIn0=
Copy-Tag: eyJwIjoiRGF0YXN0b3JlQWRtaW4vLk93bEJvdC55YW1sIiwiaCI6IjhhMTQ0ZjQ5ODVmOWY1ODAyMmVjNjJiMzc3YTYyOWZiYTM0OTViYTEifQ==
Copy-Tag: eyJwIjoiRGF0YXN0cmVhbS8uT3dsQm90LnlhbWwiLCJoIjoiOGExNDRmNDk4NWY5ZjU4MDIyZWM2MmIzNzdhNjI5ZmJhMzQ5NWJhMSJ9
Copy-Tag: eyJwIjoiRGVidWdnZXIvLk93bEJvdC55YW1sIiwiaCI6IjhhMTQ0ZjQ5ODVmOWY1ODAyMmVjNjJiMzc3YTYyOWZiYTM0OTViYTEifQ==
Copy-Tag: eyJwIjoiRGVwbG95Ly5Pd2xCb3QueWFtbCIsImgiOiI4YTE0NGY0OTg1ZjlmNTgwMjJlYzYyYjM3N2E2MjlmYmEzNDk1YmExIn0=
Copy-Tag: eyJwIjoiRGlhbG9nZmxvdy8uT3dsQm90LnlhbWwiLCJoIjoiOGExNDRmNDk4NWY5ZjU4MDIyZWM2MmIzNzdhNjI5ZmJhMzQ5NWJhMSJ9
  • Loading branch information
gcf-owl-bot[bot] authored Oct 16, 2023
1 parent 9977636 commit 61cee21
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 68 deletions.
20 changes: 10 additions & 10 deletions src/V1/Client/AutoscalingPolicyServiceClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ public function __call($method, $args)
* Creates new autoscaling policy.
*
* The async variant is
* {@see AutoscalingPolicyServiceGapicClient::createAutoscalingPolicyAsync()} .
* {@see AutoscalingPolicyServiceClient::createAutoscalingPolicyAsync()} .
*
* @param CreateAutoscalingPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -334,7 +334,7 @@ public function createAutoscalingPolicy(CreateAutoscalingPolicyRequest $request,
* policy that is in use by one or more clusters.
*
* The async variant is
* {@see AutoscalingPolicyServiceGapicClient::deleteAutoscalingPolicyAsync()} .
* {@see AutoscalingPolicyServiceClient::deleteAutoscalingPolicyAsync()} .
*
* @param DeleteAutoscalingPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -357,7 +357,7 @@ public function deleteAutoscalingPolicy(DeleteAutoscalingPolicyRequest $request,
* Retrieves autoscaling policy.
*
* The async variant is
* {@see AutoscalingPolicyServiceGapicClient::getAutoscalingPolicyAsync()} .
* {@see AutoscalingPolicyServiceClient::getAutoscalingPolicyAsync()} .
*
* @param GetAutoscalingPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -382,7 +382,7 @@ public function getAutoscalingPolicy(GetAutoscalingPolicyRequest $request, array
* Lists autoscaling policies in the project.
*
* The async variant is
* {@see AutoscalingPolicyServiceGapicClient::listAutoscalingPoliciesAsync()} .
* {@see AutoscalingPolicyServiceClient::listAutoscalingPoliciesAsync()} .
*
* @param ListAutoscalingPoliciesRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down Expand Up @@ -410,7 +410,7 @@ public function listAutoscalingPolicies(ListAutoscalingPoliciesRequest $request,
* replacements.
*
* The async variant is
* {@see AutoscalingPolicyServiceGapicClient::updateAutoscalingPolicyAsync()} .
* {@see AutoscalingPolicyServiceClient::updateAutoscalingPolicyAsync()} .
*
* @param UpdateAutoscalingPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -435,8 +435,8 @@ public function updateAutoscalingPolicy(UpdateAutoscalingPolicyRequest $request,
* 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 AutoscalingPolicyServiceGapicClient::getIamPolicyAsync()} .
* The async variant is {@see AutoscalingPolicyServiceClient::getIamPolicyAsync()}
* .
*
* @param GetIamPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down Expand Up @@ -464,8 +464,8 @@ public function getIamPolicy(GetIamPolicyRequest $request, array $callOptions =
Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
errors.
*
* The async variant is
* {@see AutoscalingPolicyServiceGapicClient::setIamPolicyAsync()} .
* The async variant is {@see AutoscalingPolicyServiceClient::setIamPolicyAsync()}
* .
*
* @param SetIamPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down Expand Up @@ -496,7 +496,7 @@ public function setIamPolicy(SetIamPolicyRequest $request, array $callOptions =
checking. This operation may "fail open" without warning.
*
* The async variant is
* {@see AutoscalingPolicyServiceGapicClient::testIamPermissionsAsync()} .
* {@see AutoscalingPolicyServiceClient::testIamPermissionsAsync()} .
*
* @param TestIamPermissionsRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down
15 changes: 7 additions & 8 deletions src/V1/Client/BatchControllerClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ public function __call($method, $args)
/**
* Creates a batch workload that executes asynchronously.
*
* The async variant is {@see BatchControllerGapicClient::createBatchAsync()} .
* The async variant is {@see BatchControllerClient::createBatchAsync()} .
*
* @param CreateBatchRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -325,7 +325,7 @@ public function createBatch(CreateBatchRequest $request, array $callOptions = []
* Deletes the batch workload resource. If the batch is not in terminal state,
* the delete fails and the response returns `FAILED_PRECONDITION`.
*
* The async variant is {@see BatchControllerGapicClient::deleteBatchAsync()} .
* The async variant is {@see BatchControllerClient::deleteBatchAsync()} .
*
* @param DeleteBatchRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -347,7 +347,7 @@ public function deleteBatch(DeleteBatchRequest $request, array $callOptions = []
/**
* Gets the batch workload resource representation.
*
* The async variant is {@see BatchControllerGapicClient::getBatchAsync()} .
* The async variant is {@see BatchControllerClient::getBatchAsync()} .
*
* @param GetBatchRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -371,7 +371,7 @@ public function getBatch(GetBatchRequest $request, array $callOptions = []): Bat
/**
* Lists batch workloads.
*
* The async variant is {@see BatchControllerGapicClient::listBatchesAsync()} .
* The async variant is {@see BatchControllerClient::listBatchesAsync()} .
*
* @param ListBatchesRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -396,7 +396,7 @@ public function listBatches(ListBatchesRequest $request, array $callOptions = []
* 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 BatchControllerGapicClient::getIamPolicyAsync()} .
* The async variant is {@see BatchControllerClient::getIamPolicyAsync()} .
*
* @param GetIamPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down Expand Up @@ -424,7 +424,7 @@ public function getIamPolicy(GetIamPolicyRequest $request, array $callOptions =
Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
errors.
*
* The async variant is {@see BatchControllerGapicClient::setIamPolicyAsync()} .
* The async variant is {@see BatchControllerClient::setIamPolicyAsync()} .
*
* @param SetIamPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down Expand Up @@ -454,8 +454,7 @@ public function setIamPolicy(SetIamPolicyRequest $request, array $callOptions =
permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.
*
* The async variant is
* {@see BatchControllerGapicClient::testIamPermissionsAsync()} .
* The async variant is {@see BatchControllerClient::testIamPermissionsAsync()} .
*
* @param TestIamPermissionsRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down
24 changes: 11 additions & 13 deletions src/V1/Client/ClusterControllerClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ public function __call($method, $args)
* [Operation.metadata][google.longrunning.Operation.metadata] will be
* [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
*
* The async variant is {@see ClusterControllerGapicClient::createClusterAsync()} .
* The async variant is {@see ClusterControllerClient::createClusterAsync()} .
*
* @param CreateClusterRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -363,7 +363,7 @@ public function createCluster(CreateClusterRequest $request, array $callOptions
* [Operation.metadata][google.longrunning.Operation.metadata] will be
* [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
*
* The async variant is {@see ClusterControllerGapicClient::deleteClusterAsync()} .
* The async variant is {@see ClusterControllerClient::deleteClusterAsync()} .
*
* @param DeleteClusterRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down Expand Up @@ -393,8 +393,7 @@ public function deleteCluster(DeleteClusterRequest $request, array $callOptions
* contains
* [DiagnoseClusterResults](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).
*
* The async variant is {@see ClusterControllerGapicClient::diagnoseClusterAsync()}
* .
* The async variant is {@see ClusterControllerClient::diagnoseClusterAsync()} .
*
* @param DiagnoseClusterRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -418,7 +417,7 @@ public function diagnoseCluster(DiagnoseClusterRequest $request, array $callOpti
/**
* Gets the resource representation for a cluster in a project.
*
* The async variant is {@see ClusterControllerGapicClient::getClusterAsync()} .
* The async variant is {@see ClusterControllerClient::getClusterAsync()} .
*
* @param GetClusterRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -442,7 +441,7 @@ public function getCluster(GetClusterRequest $request, array $callOptions = []):
/**
* Lists all regions/{region}/clusters in a project alphabetically.
*
* The async variant is {@see ClusterControllerGapicClient::listClustersAsync()} .
* The async variant is {@see ClusterControllerClient::listClustersAsync()} .
*
* @param ListClustersRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -466,7 +465,7 @@ public function listClusters(ListClustersRequest $request, array $callOptions =
/**
* Starts a cluster in a project.
*
* The async variant is {@see ClusterControllerGapicClient::startClusterAsync()} .
* The async variant is {@see ClusterControllerClient::startClusterAsync()} .
*
* @param StartClusterRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -490,7 +489,7 @@ public function startCluster(StartClusterRequest $request, array $callOptions =
/**
* Stops a cluster in a project.
*
* The async variant is {@see ClusterControllerGapicClient::stopClusterAsync()} .
* The async variant is {@see ClusterControllerClient::stopClusterAsync()} .
*
* @param StopClusterRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down Expand Up @@ -519,7 +518,7 @@ public function stopCluster(StopClusterRequest $request, array $callOptions = []
* [`RUNNING`][google.cloud.dataproc.v1.ClusterStatus.State] state or an error
* is returned.
*
* The async variant is {@see ClusterControllerGapicClient::updateClusterAsync()} .
* The async variant is {@see ClusterControllerClient::updateClusterAsync()} .
*
* @param UpdateClusterRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -544,7 +543,7 @@ public function updateCluster(UpdateClusterRequest $request, array $callOptions
* 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 ClusterControllerGapicClient::getIamPolicyAsync()} .
* The async variant is {@see ClusterControllerClient::getIamPolicyAsync()} .
*
* @param GetIamPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down Expand Up @@ -572,7 +571,7 @@ public function getIamPolicy(GetIamPolicyRequest $request, array $callOptions =
Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
errors.
*
* The async variant is {@see ClusterControllerGapicClient::setIamPolicyAsync()} .
* The async variant is {@see ClusterControllerClient::setIamPolicyAsync()} .
*
* @param SetIamPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down Expand Up @@ -602,8 +601,7 @@ public function setIamPolicy(SetIamPolicyRequest $request, array $callOptions =
permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.
*
* The async variant is
* {@see ClusterControllerGapicClient::testIamPermissionsAsync()} .
* The async variant is {@see ClusterControllerClient::testIamPermissionsAsync()} .
*
* @param TestIamPermissionsRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down
22 changes: 10 additions & 12 deletions src/V1/Client/JobControllerClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ public function __call($method, $args)
* or
* [regions/{region}/jobs.get](https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).
*
* The async variant is {@see JobControllerGapicClient::cancelJobAsync()} .
* The async variant is {@see JobControllerClient::cancelJobAsync()} .
*
* @param CancelJobRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -246,7 +246,7 @@ public function cancelJob(CancelJobRequest $request, array $callOptions = []): J
* Deletes the job from the project. If the job is active, the delete fails,
* and the response returns `FAILED_PRECONDITION`.
*
* The async variant is {@see JobControllerGapicClient::deleteJobAsync()} .
* The async variant is {@see JobControllerClient::deleteJobAsync()} .
*
* @param DeleteJobRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -268,7 +268,7 @@ public function deleteJob(DeleteJobRequest $request, array $callOptions = []): v
/**
* Gets the resource representation for a job in a project.
*
* The async variant is {@see JobControllerGapicClient::getJobAsync()} .
* The async variant is {@see JobControllerClient::getJobAsync()} .
*
* @param GetJobRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -292,7 +292,7 @@ public function getJob(GetJobRequest $request, array $callOptions = []): Job
/**
* Lists regions/{region}/jobs in a project.
*
* The async variant is {@see JobControllerGapicClient::listJobsAsync()} .
* The async variant is {@see JobControllerClient::listJobsAsync()} .
*
* @param ListJobsRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -316,7 +316,7 @@ public function listJobs(ListJobsRequest $request, array $callOptions = []): Pag
/**
* Submits a job to a cluster.
*
* The async variant is {@see JobControllerGapicClient::submitJobAsync()} .
* The async variant is {@see JobControllerClient::submitJobAsync()} .
*
* @param SubmitJobRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -340,8 +340,7 @@ public function submitJob(SubmitJobRequest $request, array $callOptions = []): J
/**
* Submits job to a cluster.
*
* The async variant is
* {@see JobControllerGapicClient::submitJobAsOperationAsync()} .
* The async variant is {@see JobControllerClient::submitJobAsOperationAsync()} .
*
* @param SubmitJobRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -365,7 +364,7 @@ public function submitJobAsOperation(SubmitJobRequest $request, array $callOptio
/**
* Updates a job in a project.
*
* The async variant is {@see JobControllerGapicClient::updateJobAsync()} .
* The async variant is {@see JobControllerClient::updateJobAsync()} .
*
* @param UpdateJobRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand All @@ -390,7 +389,7 @@ public function updateJob(UpdateJobRequest $request, array $callOptions = []): J
* 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 JobControllerGapicClient::getIamPolicyAsync()} .
* The async variant is {@see JobControllerClient::getIamPolicyAsync()} .
*
* @param GetIamPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down Expand Up @@ -418,7 +417,7 @@ public function getIamPolicy(GetIamPolicyRequest $request, array $callOptions =
Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
errors.
*
* The async variant is {@see JobControllerGapicClient::setIamPolicyAsync()} .
* The async variant is {@see JobControllerClient::setIamPolicyAsync()} .
*
* @param SetIamPolicyRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down Expand Up @@ -448,8 +447,7 @@ public function setIamPolicy(SetIamPolicyRequest $request, array $callOptions =
permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.
*
* The async variant is {@see JobControllerGapicClient::testIamPermissionsAsync()}
* .
* The async variant is {@see JobControllerClient::testIamPermissionsAsync()} .
*
* @param TestIamPermissionsRequest $request A request to house fields associated with the call.
* @param array $callOptions {
Expand Down
Loading

0 comments on commit 61cee21

Please sign in to comment.