Skip to content

Commit

Permalink
chore(docs): improved phpdoc for clients (#6356)
Browse files Browse the repository at this point in the history
* 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: googleapis/googleapis@277df0e

Source-Link: googleapis/googleapis-gen@e7ec1f4
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 <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Jun 13, 2023
1 parent 099fb7b commit 40aab37
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
3 changes: 3 additions & 0 deletions WebRisk/src/V1/Gapic/WebRiskServiceGapicClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
10 changes: 10 additions & 0 deletions Workflows/src/V1/Client/BaseClient/WorkflowsBaseClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 40aab37

Please sign in to comment.