From 40aab3767ac83f0c8a2949c9b1c89c7c78f40113 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 13 Jun 2023 18:42:54 +0000 Subject: [PATCH] chore(docs): improved phpdoc for clients (#6356) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: Added ClusterView supporting more granular view of continuous backups feat: Added new SSL modes ALLOW_UNENCRYPTED_AND_ENCRYPTED, ENCRYPTED_ONLY feat: Added users API feat: Added fault injection API feat: Added instance update policy feat: Added cluster network config fix: Deprecated SSL modes SSL_MODE_ALLOW, SSL_MODE_REQUIRE, SSL_MODE_VERIFY_CA PiperOrigin-RevId: 539726243 Source-Link: https://github.com/googleapis/googleapis/commit/277df0ec41d2f78e21998b3241223e148f8b3eb1 Source-Link: https://github.com/googleapis/googleapis-gen/commit/e7ec1f4788e628c686dfe4b5096bd4894c0cc54c Copy-Tag: eyJwIjoiV2ViUmlzay8uT3dsQm90LnlhbWwiLCJoIjoiZTdlYzFmNDc4OGU2MjhjNjg2ZGZlNGI1MDk2YmQ0ODk0YzBjYzU0YyJ9 Copy-Tag: eyJwIjoiV2ViU2VjdXJpdHlTY2FubmVyLy5Pd2xCb3QueWFtbCIsImgiOiJlN2VjMWY0Nzg4ZTYyOGM2ODZkZmU0YjUwOTZiZDQ4OTRjMGNjNTRjIn0= Copy-Tag: eyJwIjoiV29ya2Zsb3dzLy5Pd2xCb3QueWFtbCIsImgiOiJlN2VjMWY0Nzg4ZTYyOGM2ODZkZmU0YjUwOTZiZDQ4OTRjMGNjNTRjIn0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- .../BaseClient/WebRiskServiceBaseClient.php | 3 ++- .../V1/Gapic/WebRiskServiceGapicClient.php | 3 +++ .../WebSecurityScannerBaseClient.php | 26 +++++++++++++++++++ .../BaseClient/ExecutionsBaseClient.php | 8 ++++++ .../Client/BaseClient/WorkflowsBaseClient.php | 10 +++++++ 5 files changed, 49 insertions(+), 1 deletion(-) diff --git a/WebRisk/src/V1/Client/BaseClient/WebRiskServiceBaseClient.php b/WebRisk/src/V1/Client/BaseClient/WebRiskServiceBaseClient.php index fb5c20769a59..1f2bc4bb1b9c 100644 --- a/WebRisk/src/V1/Client/BaseClient/WebRiskServiceBaseClient.php +++ b/WebRisk/src/V1/Client/BaseClient/WebRiskServiceBaseClient.php @@ -58,7 +58,8 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * - * This class is currently experimental and may be subject to changes. + * This class is currently experimental and may be subject to changes. See {@see + * \Google\Cloud\WebRisk\V1\WebRiskServiceClient} for the stable implementation * * @experimental * diff --git a/WebRisk/src/V1/Gapic/WebRiskServiceGapicClient.php b/WebRisk/src/V1/Gapic/WebRiskServiceGapicClient.php index 878db530873d..91469b4b66d7 100644 --- a/WebRisk/src/V1/Gapic/WebRiskServiceGapicClient.php +++ b/WebRisk/src/V1/Gapic/WebRiskServiceGapicClient.php @@ -72,6 +72,9 @@ * assist with these names, this class includes a format method for each type of * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. + * + * This service has a new (beta) implementation. See {@see + * \Google\Cloud\WebRisk\V1\Client\WebRiskServiceClient} to use the new surface. */ class WebRiskServiceGapicClient { diff --git a/WebSecurityScanner/src/V1/Client/BaseClient/WebSecurityScannerBaseClient.php b/WebSecurityScanner/src/V1/Client/BaseClient/WebSecurityScannerBaseClient.php index b8394c87a495..967cc37063b9 100644 --- a/WebSecurityScanner/src/V1/Client/BaseClient/WebSecurityScannerBaseClient.php +++ b/WebSecurityScanner/src/V1/Client/BaseClient/WebSecurityScannerBaseClient.php @@ -195,6 +195,8 @@ public function __call($method, $args) * * The async variant is {@see self::createScanConfigAsync()} . * + * @example samples/V1/WebSecurityScannerClient/create_scan_config.php + * * @param CreateScanConfigRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -219,6 +221,8 @@ public function createScanConfig(CreateScanConfigRequest $request, array $callOp * * The async variant is {@see self::deleteScanConfigAsync()} . * + * @example samples/V1/WebSecurityScannerClient/delete_scan_config.php + * * @param DeleteScanConfigRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -241,6 +245,8 @@ public function deleteScanConfig(DeleteScanConfigRequest $request, array $callOp * * The async variant is {@see self::getFindingAsync()} . * + * @example samples/V1/WebSecurityScannerClient/get_finding.php + * * @param GetFindingRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -265,6 +271,8 @@ public function getFinding(GetFindingRequest $request, array $callOptions = []): * * The async variant is {@see self::getScanConfigAsync()} . * + * @example samples/V1/WebSecurityScannerClient/get_scan_config.php + * * @param GetScanConfigRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -289,6 +297,8 @@ public function getScanConfig(GetScanConfigRequest $request, array $callOptions * * The async variant is {@see self::getScanRunAsync()} . * + * @example samples/V1/WebSecurityScannerClient/get_scan_run.php + * * @param GetScanRunRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -313,6 +323,8 @@ public function getScanRun(GetScanRunRequest $request, array $callOptions = []): * * The async variant is {@see self::listCrawledUrlsAsync()} . * + * @example samples/V1/WebSecurityScannerClient/list_crawled_urls.php + * * @param ListCrawledUrlsRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -337,6 +349,8 @@ public function listCrawledUrls(ListCrawledUrlsRequest $request, array $callOpti * * The async variant is {@see self::listFindingTypeStatsAsync()} . * + * @example samples/V1/WebSecurityScannerClient/list_finding_type_stats.php + * * @param ListFindingTypeStatsRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -361,6 +375,8 @@ public function listFindingTypeStats(ListFindingTypeStatsRequest $request, array * * The async variant is {@see self::listFindingsAsync()} . * + * @example samples/V1/WebSecurityScannerClient/list_findings.php + * * @param ListFindingsRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -385,6 +401,8 @@ public function listFindings(ListFindingsRequest $request, array $callOptions = * * The async variant is {@see self::listScanConfigsAsync()} . * + * @example samples/V1/WebSecurityScannerClient/list_scan_configs.php + * * @param ListScanConfigsRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -410,6 +428,8 @@ public function listScanConfigs(ListScanConfigsRequest $request, array $callOpti * * The async variant is {@see self::listScanRunsAsync()} . * + * @example samples/V1/WebSecurityScannerClient/list_scan_runs.php + * * @param ListScanRunsRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -434,6 +454,8 @@ public function listScanRuns(ListScanRunsRequest $request, array $callOptions = * * The async variant is {@see self::startScanRunAsync()} . * + * @example samples/V1/WebSecurityScannerClient/start_scan_run.php + * * @param StartScanRunRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -458,6 +480,8 @@ public function startScanRun(StartScanRunRequest $request, array $callOptions = * * The async variant is {@see self::stopScanRunAsync()} . * + * @example samples/V1/WebSecurityScannerClient/stop_scan_run.php + * * @param StopScanRunRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -482,6 +506,8 @@ public function stopScanRun(StopScanRunRequest $request, array $callOptions = [] * * The async variant is {@see self::updateScanConfigAsync()} . * + * @example samples/V1/WebSecurityScannerClient/update_scan_config.php + * * @param UpdateScanConfigRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. diff --git a/Workflows/src/Executions/V1/Client/BaseClient/ExecutionsBaseClient.php b/Workflows/src/Executions/V1/Client/BaseClient/ExecutionsBaseClient.php index c7466cbd2e53..011a711708ae 100644 --- a/Workflows/src/Executions/V1/Client/BaseClient/ExecutionsBaseClient.php +++ b/Workflows/src/Executions/V1/Client/BaseClient/ExecutionsBaseClient.php @@ -245,6 +245,8 @@ public function __call($method, $args) * * The async variant is {@see self::cancelExecutionAsync()} . * + * @example samples/V1/ExecutionsClient/cancel_execution.php + * * @param CancelExecutionRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -269,6 +271,8 @@ public function cancelExecution(CancelExecutionRequest $request, array $callOpti * * The async variant is {@see self::createExecutionAsync()} . * + * @example samples/V1/ExecutionsClient/create_execution.php + * * @param CreateExecutionRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -293,6 +297,8 @@ public function createExecution(CreateExecutionRequest $request, array $callOpti * * The async variant is {@see self::getExecutionAsync()} . * + * @example samples/V1/ExecutionsClient/get_execution.php + * * @param GetExecutionRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -320,6 +326,8 @@ public function getExecution(GetExecutionRequest $request, array $callOptions = * * The async variant is {@see self::listExecutionsAsync()} . * + * @example samples/V1/ExecutionsClient/list_executions.php + * * @param ListExecutionsRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. diff --git a/Workflows/src/V1/Client/BaseClient/WorkflowsBaseClient.php b/Workflows/src/V1/Client/BaseClient/WorkflowsBaseClient.php index 898a0bd8332c..3c8aa0279ba5 100644 --- a/Workflows/src/V1/Client/BaseClient/WorkflowsBaseClient.php +++ b/Workflows/src/V1/Client/BaseClient/WorkflowsBaseClient.php @@ -281,6 +281,8 @@ public function __call($method, $args) * * The async variant is {@see self::createWorkflowAsync()} . * + * @example samples/V1/WorkflowsClient/create_workflow.php + * * @param CreateWorkflowRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -307,6 +309,8 @@ public function createWorkflow(CreateWorkflowRequest $request, array $callOption * * The async variant is {@see self::deleteWorkflowAsync()} . * + * @example samples/V1/WorkflowsClient/delete_workflow.php + * * @param DeleteWorkflowRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -331,6 +335,8 @@ public function deleteWorkflow(DeleteWorkflowRequest $request, array $callOption * * The async variant is {@see self::getWorkflowAsync()} . * + * @example samples/V1/WorkflowsClient/get_workflow.php + * * @param GetWorkflowRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -356,6 +362,8 @@ public function getWorkflow(GetWorkflowRequest $request, array $callOptions = [] * * The async variant is {@see self::listWorkflowsAsync()} . * + * @example samples/V1/WorkflowsClient/list_workflows.php + * * @param ListWorkflowsRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional. @@ -384,6 +392,8 @@ public function listWorkflows(ListWorkflowsRequest $request, array $callOptions * * The async variant is {@see self::updateWorkflowAsync()} . * + * @example samples/V1/WorkflowsClient/update_workflow.php + * * @param UpdateWorkflowRequest $request A request to house fields associated with the call. * @param array $callOptions { * Optional.