Skip to content
This repository was archived by the owner on Sep 5, 2023. It is now read-only.

docs: Fix formatting of request arg in docstring #259

Merged
parthea merged 2 commits into from
Mar 23, 2023
Merged

docs: Fix formatting of request arg in docstring #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c2d6b8
docs: Fix formatting of request arg in docstring
gcf-owl-bot[bot] Mar 22, 2023
bc28630
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 11 additions & 22 deletions google/cloud/functions_v1/services/cloud_functions_service/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,7 @@ async def sample_list_functions():

Args:
request (Optional[Union[google.cloud.functions_v1.types.ListFunctionsRequest, dict]]):
The request object. Request for the `ListFunctions`
method.
The request object. Request for the ``ListFunctions`` method.
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 @@ -379,8 +378,7 @@ async def sample_get_function():

Args:
request (Optional[Union[google.cloud.functions_v1.types.GetFunctionRequest, dict]]):
The request object. Request for the `GetFunction`
method.
The request object. Request for the ``GetFunction`` method.
name (:class:`str`):
Required. The name of the function
which details should be obtained.
Expand Down Expand Up @@ -504,8 +502,7 @@ async def sample_create_function():

Args:
request (Optional[Union[google.cloud.functions_v1.types.CreateFunctionRequest, dict]]):
The request object. Request for the `CreateFunction`
method.
The request object. Request for the ``CreateFunction`` method.
location (:class:`str`):
Required. The project and location in which the function
should be created, specified in the format
Expand Down Expand Up @@ -632,8 +629,7 @@ async def sample_update_function():

Args:
request (Optional[Union[google.cloud.functions_v1.types.UpdateFunctionRequest, dict]]):
The request object. Request for the `UpdateFunction`
method.
The request object. Request for the ``UpdateFunction`` method.
function (:class:`google.cloud.functions_v1.types.CloudFunction`):
Required. New version of the
function.
Expand Down Expand Up @@ -764,8 +760,7 @@ async def sample_delete_function():

Args:
request (Optional[Union[google.cloud.functions_v1.types.DeleteFunctionRequest, dict]]):
The request object. Request for the `DeleteFunction`
method.
The request object. Request for the ``DeleteFunction`` method.
name (:class:`str`):
Required. The name of the function
which should be deleted.
Expand Down Expand Up @@ -899,8 +894,7 @@ async def sample_call_function():

Args:
request (Optional[Union[google.cloud.functions_v1.types.CallFunctionRequest, dict]]):
The request object. Request for the `CallFunction`
method.
The request object. Request for the ``CallFunction`` method.
name (:class:`str`):
Required. The name of the function to
be called.
Expand Down Expand Up @@ -1033,8 +1027,7 @@ async def sample_generate_upload_url():

Args:
request (Optional[Union[google.cloud.functions_v1.types.GenerateUploadUrlRequest, dict]]):
The request object. Request of `GenerateSourceUploadUrl`
method.
The request object. Request of ``GenerateSourceUploadUrl`` method.
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 @@ -1115,8 +1108,7 @@ async def sample_generate_download_url():

Args:
request (Optional[Union[google.cloud.functions_v1.types.GenerateDownloadUrlRequest, dict]]):
The request object. Request of `GenerateDownloadUrl`
method.
The request object. Request of ``GenerateDownloadUrl`` method.
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 @@ -1195,8 +1187,7 @@ async def sample_set_iam_policy():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
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 @@ -1340,8 +1331,7 @@ async def sample_get_iam_policy():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
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 @@ -1486,8 +1476,7 @@ async def sample_test_iam_permissions():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
33 changes: 11 additions & 22 deletions google/cloud/functions_v1/services/cloud_functions_service/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,8 +540,7 @@ def sample_list_functions():

Args:
request (Union[google.cloud.functions_v1.types.ListFunctionsRequest, dict]):
The request object. Request for the `ListFunctions`
method.
The request object. Request for the ``ListFunctions`` method.
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 @@ -634,8 +633,7 @@ def sample_get_function():

Args:
request (Union[google.cloud.functions_v1.types.GetFunctionRequest, dict]):
The request object. Request for the `GetFunction`
method.
The request object. Request for the ``GetFunction`` method.
name (str):
Required. The name of the function
which details should be obtained.
Expand Down Expand Up @@ -749,8 +747,7 @@ def sample_create_function():

Args:
request (Union[google.cloud.functions_v1.types.CreateFunctionRequest, dict]):
The request object. Request for the `CreateFunction`
method.
The request object. Request for the ``CreateFunction`` method.
location (str):
Required. The project and location in which the function
should be created, specified in the format
Expand Down Expand Up @@ -877,8 +874,7 @@ def sample_update_function():

Args:
request (Union[google.cloud.functions_v1.types.UpdateFunctionRequest, dict]):
The request object. Request for the `UpdateFunction`
method.
The request object. Request for the ``UpdateFunction`` method.
function (google.cloud.functions_v1.types.CloudFunction):
Required. New version of the
function.
Expand Down Expand Up @@ -999,8 +995,7 @@ def sample_delete_function():

Args:
request (Union[google.cloud.functions_v1.types.DeleteFunctionRequest, dict]):
The request object. Request for the `DeleteFunction`
method.
The request object. Request for the ``DeleteFunction`` method.
name (str):
Required. The name of the function
which should be deleted.
Expand Down Expand Up @@ -1124,8 +1119,7 @@ def sample_call_function():

Args:
request (Union[google.cloud.functions_v1.types.CallFunctionRequest, dict]):
The request object. Request for the `CallFunction`
method.
The request object. Request for the ``CallFunction`` method.
name (str):
Required. The name of the function to
be called.
Expand Down Expand Up @@ -1258,8 +1252,7 @@ def sample_generate_upload_url():

Args:
request (Union[google.cloud.functions_v1.types.GenerateUploadUrlRequest, dict]):
The request object. Request of `GenerateSourceUploadUrl`
method.
The request object. Request of ``GenerateSourceUploadUrl`` method.
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 @@ -1341,8 +1334,7 @@ def sample_generate_download_url():

Args:
request (Union[google.cloud.functions_v1.types.GenerateDownloadUrlRequest, dict]):
The request object. Request of `GenerateDownloadUrl`
method.
The request object. Request of ``GenerateDownloadUrl`` method.
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 @@ -1422,8 +1414,7 @@ def sample_set_iam_policy():

Args:
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
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 @@ -1566,8 +1557,7 @@ def sample_get_iam_policy():

Args:
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
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 @@ -1711,8 +1701,7 @@ def sample_test_iam_permissions():

Args:
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
24 changes: 8 additions & 16 deletions google/cloud/functions_v2/services/function_service/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,8 +288,7 @@ async def sample_get_function():

Args:
request (Optional[Union[google.cloud.functions_v2.types.GetFunctionRequest, dict]]):
The request object. Request for the `GetFunction`
method.
The request object. Request for the ``GetFunction`` method.
name (:class:`str`):
Required. The name of the function
which details should be obtained.
Expand Down Expand Up @@ -394,8 +393,7 @@ async def sample_list_functions():

Args:
request (Optional[Union[google.cloud.functions_v2.types.ListFunctionsRequest, dict]]):
The request object. Request for the `ListFunctions`
method.
The request object. Request for the ``ListFunctions`` method.
parent (:class:`str`):
Required. The project and location from which the
function should be listed, specified in the format
Expand Down Expand Up @@ -521,8 +519,7 @@ async def sample_create_function():

Args:
request (Optional[Union[google.cloud.functions_v2.types.CreateFunctionRequest, dict]]):
The request object. Request for the `CreateFunction`
method.
The request object. Request for the ``CreateFunction`` method.
parent (:class:`str`):
Required. The project and location in which the function
should be created, specified in the format
Expand Down Expand Up @@ -658,8 +655,7 @@ async def sample_update_function():

Args:
request (Optional[Union[google.cloud.functions_v2.types.UpdateFunctionRequest, dict]]):
The request object. Request for the `UpdateFunction`
method.
The request object. Request for the ``UpdateFunction`` method.
function (:class:`google.cloud.functions_v2.types.Function`):
Required. New version of the
function.
Expand Down Expand Up @@ -791,8 +787,7 @@ async def sample_delete_function():

Args:
request (Optional[Union[google.cloud.functions_v2.types.DeleteFunctionRequest, dict]]):
The request object. Request for the `DeleteFunction`
method.
The request object. Request for the ``DeleteFunction`` method.
name (:class:`str`):
Required. The name of the function
which should be deleted.
Expand Down Expand Up @@ -935,8 +930,7 @@ async def sample_generate_upload_url():

Args:
request (Optional[Union[google.cloud.functions_v2.types.GenerateUploadUrlRequest, dict]]):
The request object. Request of `GenerateSourceUploadUrl`
method.
The request object. Request of ``GenerateSourceUploadUrl`` method.
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 @@ -1018,8 +1012,7 @@ async def sample_generate_download_url():

Args:
request (Optional[Union[google.cloud.functions_v2.types.GenerateDownloadUrlRequest, dict]]):
The request object. Request of `GenerateDownloadUrl`
method.
The request object. Request of ``GenerateDownloadUrl`` method.
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 @@ -1098,8 +1091,7 @@ async def sample_list_runtimes():

Args:
request (Optional[Union[google.cloud.functions_v2.types.ListRuntimesRequest, dict]]):
The request object. Request for the `ListRuntimes`
method.
The request object. Request for the ``ListRuntimes`` method.
parent (:class:`str`):
Required. The project and location from which the
runtimes should be listed, specified in the format
Expand Down
24 changes: 8 additions & 16 deletions google/cloud/functions_v2/services/function_service/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,8 +698,7 @@ def sample_get_function():

Args:
request (Union[google.cloud.functions_v2.types.GetFunctionRequest, dict]):
The request object. Request for the `GetFunction`
method.
The request object. Request for the ``GetFunction`` method.
name (str):
Required. The name of the function
which details should be obtained.
Expand Down Expand Up @@ -804,8 +803,7 @@ def sample_list_functions():

Args:
request (Union[google.cloud.functions_v2.types.ListFunctionsRequest, dict]):
The request object. Request for the `ListFunctions`
method.
The request object. Request for the ``ListFunctions`` method.
parent (str):
Required. The project and location from which the
function should be listed, specified in the format
Expand Down Expand Up @@ -931,8 +929,7 @@ def sample_create_function():

Args:
request (Union[google.cloud.functions_v2.types.CreateFunctionRequest, dict]):
The request object. Request for the `CreateFunction`
method.
The request object. Request for the ``CreateFunction`` method.
parent (str):
Required. The project and location in which the function
should be created, specified in the format
Expand Down Expand Up @@ -1068,8 +1065,7 @@ def sample_update_function():

Args:
request (Union[google.cloud.functions_v2.types.UpdateFunctionRequest, dict]):
The request object. Request for the `UpdateFunction`
method.
The request object. Request for the ``UpdateFunction`` method.
function (google.cloud.functions_v2.types.Function):
Required. New version of the
function.
Expand Down Expand Up @@ -1201,8 +1197,7 @@ def sample_delete_function():

Args:
request (Union[google.cloud.functions_v2.types.DeleteFunctionRequest, dict]):
The request object. Request for the `DeleteFunction`
method.
The request object. Request for the ``DeleteFunction`` method.
name (str):
Required. The name of the function
which should be deleted.
Expand Down Expand Up @@ -1345,8 +1340,7 @@ def sample_generate_upload_url():

Args:
request (Union[google.cloud.functions_v2.types.GenerateUploadUrlRequest, dict]):
The request object. Request of `GenerateSourceUploadUrl`
method.
The request object. Request of ``GenerateSourceUploadUrl`` method.
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 @@ -1429,8 +1423,7 @@ def sample_generate_download_url():

Args:
request (Union[google.cloud.functions_v2.types.GenerateDownloadUrlRequest, dict]):
The request object. Request of `GenerateDownloadUrl`
method.
The request object. Request of ``GenerateDownloadUrl`` method.
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 @@ -1510,8 +1503,7 @@ def sample_list_runtimes():

Args:
request (Union[google.cloud.functions_v2.types.ListRuntimesRequest, dict]):
The request object. Request for the `ListRuntimes`
method.
The request object. Request for the ``ListRuntimes`` method.
parent (str):
Required. The project and location from which the
runtimes should be listed, specified in the format
Expand Down