Skip to content

Commit

Permalink
docs: Fix formatting of request arg in docstring (#54)
Browse files Browse the repository at this point in the history 
* chore: Update gapic-generator-python to v1.9.0

PiperOrigin-RevId: 517425588

Source-Link: googleapis/googleapis@33c93eb

Source-Link: googleapis/googleapis-gen@d5f5978
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZDVmNTk3ODlkMTlmYzQzMjcwZmYyMTI0OTY3ZDRlYzg5OTJiOGU4ZiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* docs: Fix formatting of request arg in docstring

chore: Update gapic-generator-python to v1.9.1
PiperOrigin-RevId: 518604533

Source-Link: googleapis/googleapis@8a085ae

Source-Link: googleapis/googleapis-gen@b2ab4b0
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9

* 🦉 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
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Mar 23, 2023
1 parent 768cc77 commit 5d71c16
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 108 deletions.
89 changes: 36 additions & 53 deletions ...ges/google-cloud-dataform/google/cloud/dataform_v1beta1/services/dataform/async_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ async def sample_list_repositories():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.ListRepositoriesRequest, dict]]):
The request object. `ListRepositories` request message.
The request object. ``ListRepositories`` request message.
parent (:class:`str`):
Required. The location in which to list repositories.
Must be in the format ``projects/*/locations/*``.
Expand Down Expand Up @@ -378,7 +378,7 @@ async def sample_get_repository():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.GetRepositoryRequest, dict]]):
The request object. `GetRepository` request message.
The request object. ``GetRepository`` request message.
name (:class:`str`):
Required. The repository's name.
This corresponds to the ``name`` field
Expand Down Expand Up @@ -479,7 +479,7 @@ async def sample_create_repository():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.CreateRepositoryRequest, dict]]):
The request object. `CreateRepository` request message.
The request object. ``CreateRepository`` request message.
parent (:class:`str`):
Required. The location in which to create the
repository. Must be in the format
Expand Down Expand Up @@ -597,7 +597,7 @@ async def sample_update_repository():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.UpdateRepositoryRequest, dict]]):
The request object. `UpdateRepository` request message.
The request object. ``UpdateRepository`` request message.
repository (:class:`google.cloud.dataform_v1beta1.types.Repository`):
Required. The repository to update.
This corresponds to the ``repository`` field
Expand Down Expand Up @@ -703,7 +703,7 @@ async def sample_delete_repository():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.DeleteRepositoryRequest, dict]]):
The request object. `DeleteRepository` request message.
The request object. ``DeleteRepository`` request message.
name (:class:`str`):
Required. The repository's name.
This corresponds to the ``name`` field
Expand Down Expand Up @@ -792,8 +792,7 @@ async def sample_fetch_remote_branches():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.FetchRemoteBranchesRequest, dict]]):
The request object. `FetchRemoteBranches` request
message.
The request object. ``FetchRemoteBranches`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -872,7 +871,7 @@ async def sample_list_workspaces():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.ListWorkspacesRequest, dict]]):
The request object. `ListWorkspaces` request message.
The request object. ``ListWorkspaces`` request message.
parent (:class:`str`):
Required. The repository in which to list workspaces.
Must be in the format
Expand Down Expand Up @@ -985,7 +984,7 @@ async def sample_get_workspace():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.GetWorkspaceRequest, dict]]):
The request object. `GetWorkspace` request message.
The request object. ``GetWorkspace`` request message.
name (:class:`str`):
Required. The workspace's name.
This corresponds to the ``name`` field
Expand Down Expand Up @@ -1085,7 +1084,7 @@ async def sample_create_workspace():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.CreateWorkspaceRequest, dict]]):
The request object. `CreateWorkspace` request message.
The request object. ``CreateWorkspace`` request message.
parent (:class:`str`):
Required. The repository in which to create the
workspace. Must be in the format
Expand Down Expand Up @@ -1200,7 +1199,7 @@ async def sample_delete_workspace():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.DeleteWorkspaceRequest, dict]]):
The request object. `DeleteWorkspace` request message.
The request object. ``DeleteWorkspace`` request message.
name (:class:`str`):
Required. The workspace resource's
name.
Expand Down Expand Up @@ -1292,8 +1291,7 @@ async def sample_install_npm_packages():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.InstallNpmPackagesRequest, dict]]):
The request object. `InstallNpmPackages` request
message.
The request object. ``InstallNpmPackages`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1375,7 +1373,7 @@ async def sample_pull_git_commits():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.PullGitCommitsRequest, dict]]):
The request object. `PullGitCommits` request message.
The request object. ``PullGitCommits`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1443,7 +1441,7 @@ async def sample_push_git_commits():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.PushGitCommitsRequest, dict]]):
The request object. `PushGitCommits` request message.
The request object. ``PushGitCommits`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1513,8 +1511,7 @@ async def sample_fetch_file_git_statuses():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.FetchFileGitStatusesRequest, dict]]):
The request object. `FetchFileGitStatuses` request
message.
The request object. ``FetchFileGitStatuses`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1591,8 +1588,7 @@ async def sample_fetch_git_ahead_behind():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.FetchGitAheadBehindRequest, dict]]):
The request object. `FetchGitAheadBehind` request
message.
The request object. ``FetchGitAheadBehind`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1672,8 +1668,7 @@ async def sample_commit_workspace_changes():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.CommitWorkspaceChangesRequest, dict]]):
The request object. `CommitWorkspaceChanges` request
message.
The request object. ``CommitWorkspaceChanges`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1741,8 +1736,7 @@ async def sample_reset_workspace_changes():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.ResetWorkspaceChangesRequest, dict]]):
The request object. `ResetWorkspaceChanges` request
message.
The request object. ``ResetWorkspaceChanges`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1814,7 +1808,7 @@ async def sample_fetch_file_diff():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.FetchFileDiffRequest, dict]]):
The request object. `FetchFileDiff` request message.
The request object. ``FetchFileDiff`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1894,8 +1888,7 @@ async def sample_query_directory_contents():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.QueryDirectoryContentsRequest, dict]]):
The request object. `QueryDirectoryContents` request
message.
The request object. ``QueryDirectoryContents`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1988,7 +1981,7 @@ async def sample_make_directory():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.MakeDirectoryRequest, dict]]):
The request object. `MakeDirectory` request message.
The request object. ``MakeDirectory`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2066,7 +2059,7 @@ async def sample_remove_directory():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.RemoveDirectoryRequest, dict]]):
The request object. `RemoveDirectory` request message.
The request object. ``RemoveDirectory`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2141,7 +2134,7 @@ async def sample_move_directory():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.MoveDirectoryRequest, dict]]):
The request object. `MoveDirectory` request message.
The request object. ``MoveDirectory`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2221,7 +2214,7 @@ async def sample_read_file():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.ReadFileRequest, dict]]):
The request object. `ReadFile` request message.
The request object. ``ReadFile`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2298,7 +2291,7 @@ async def sample_remove_file():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.RemoveFileRequest, dict]]):
The request object. `RemoveFile` request message.
The request object. ``RemoveFile`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2372,7 +2365,7 @@ async def sample_move_file():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.MoveFileRequest, dict]]):
The request object. `MoveFile` request message.
The request object. ``MoveFile`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2453,7 +2446,7 @@ async def sample_write_file():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.WriteFileRequest, dict]]):
The request object. `WriteFile` request message.
The request object. ``WriteFile`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2534,8 +2527,7 @@ async def sample_list_compilation_results():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.ListCompilationResultsRequest, dict]]):
The request object. `ListCompilationResults` request
message.
The request object. ``ListCompilationResults`` request message.
parent (:class:`str`):
Required. The repository in which to list compilation
results. Must be in the format
Expand Down Expand Up @@ -2648,8 +2640,7 @@ async def sample_get_compilation_result():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.GetCompilationResultRequest, dict]]):
The request object. `GetCompilationResult` request
message.
The request object. ``GetCompilationResult`` request message.
name (:class:`str`):
Required. The compilation result's
name.
Expand Down Expand Up @@ -2756,8 +2747,7 @@ async def sample_create_compilation_result():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.CreateCompilationResultRequest, dict]]):
The request object. `CreateCompilationResult` request
message.
The request object. ``CreateCompilationResult`` request message.
parent (:class:`str`):
Required. The repository in which to create the
compilation result. Must be in the format
Expand Down Expand Up @@ -2871,8 +2861,7 @@ async def sample_query_compilation_result_actions():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.QueryCompilationResultActionsRequest, dict]]):
The request object. `QueryCompilationResultActions`
request message.
The request object. ``QueryCompilationResultActions`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2964,8 +2953,7 @@ async def sample_list_workflow_invocations():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.ListWorkflowInvocationsRequest, dict]]):
The request object. `ListWorkflowInvocations` request
message.
The request object. ``ListWorkflowInvocations`` request message.
parent (:class:`str`):
Required. The parent resource of the WorkflowInvocation
type. Must be in the format
Expand Down Expand Up @@ -3078,8 +3066,7 @@ async def sample_get_workflow_invocation():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.GetWorkflowInvocationRequest, dict]]):
The request object. `GetWorkflowInvocation` request
message.
The request object. ``GetWorkflowInvocation`` request message.
name (:class:`str`):
Required. The workflow invocation
resource's name.
Expand Down Expand Up @@ -3182,8 +3169,7 @@ async def sample_create_workflow_invocation():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.CreateWorkflowInvocationRequest, dict]]):
The request object. `CreateWorkflowInvocation` request
message.
The request object. ``CreateWorkflowInvocation`` request message.
parent (:class:`str`):
Required. The repository in which to create the workflow
invocation. Must be in the format
Expand Down Expand Up @@ -3291,8 +3277,7 @@ async def sample_delete_workflow_invocation():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.DeleteWorkflowInvocationRequest, dict]]):
The request object. `DeleteWorkflowInvocation` request
message.
The request object. ``DeleteWorkflowInvocation`` request message.
name (:class:`str`):
Required. The workflow invocation
resource's name.
Expand Down Expand Up @@ -3381,8 +3366,7 @@ async def sample_cancel_workflow_invocation():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.CancelWorkflowInvocationRequest, dict]]):
The request object. `CancelWorkflowInvocation` request
message.
The request object. ``CancelWorkflowInvocation`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -3456,8 +3440,7 @@ async def sample_query_workflow_invocation_actions():
Args:
request (Optional[Union[google.cloud.dataform_v1beta1.types.QueryWorkflowInvocationActionsRequest, dict]]):
The request object. `QueryWorkflowInvocationActions`
request message.
The request object. ``QueryWorkflowInvocationActions`` request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Loading

0 comments on commit 5d71c16

Please sign in to comment.