Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Fix formatting of request arg in docstring #756

Merged
merged 2 commits into from
Mar 23, 2023
Merged

docs: Fix formatting of request arg in docstring #756

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
9cb0164
docs: Fix formatting of request arg in docstring
gcf-owl-bot[bot] Mar 22, 2023
5cea88b
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 22, 2023
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1137,8 +1137,8 @@ async def update_cluster(

Args:
request (Optional[Union[google.cloud.bigtable_admin_v2.types.Cluster, dict]]):
The request object. A resizable group of nodes in a
particular cloud location, capable of serving all
The request object. A resizable group of nodes in a particular cloud
location, capable of serving all
[Tables][google.bigtable.admin.v2.Table] in the parent
[Instance][google.bigtable.admin.v2.Instance].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
Expand Down Expand Up @@ -1880,8 +1880,7 @@ async def 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.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -2030,8 +2029,7 @@ async def 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.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -2171,8 +2169,7 @@ async def 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.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
13 changes: 5 additions & 8 deletions google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1400,8 +1400,8 @@ def update_cluster(

Args:
request (Union[google.cloud.bigtable_admin_v2.types.Cluster, dict]):
The request object. A resizable group of nodes in a
particular cloud location, capable of serving all
The request object. A resizable group of nodes in a particular cloud
location, capable of serving all
[Tables][google.bigtable.admin.v2.Table] in the parent
[Instance][google.bigtable.admin.v2.Instance].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
Expand Down Expand Up @@ -2104,8 +2104,7 @@ def 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.
resource (str):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -2241,8 +2240,7 @@ def 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.
resource (str):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -2379,8 +2377,7 @@ def 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.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
18 changes: 0 additions & 18 deletions google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -874,7 +874,6 @@ def __call__(
request (~.bigtable_instance_admin.CreateAppProfileRequest):
The request object. Request message for
BigtableInstanceAdmin.CreateAppProfile.

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 @@ -978,7 +977,6 @@ def __call__(
request (~.bigtable_instance_admin.CreateClusterRequest):
The request object. Request message for
BigtableInstanceAdmin.CreateCluster.

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 @@ -1076,7 +1074,6 @@ def __call__(
request (~.bigtable_instance_admin.CreateInstanceRequest):
The request object. Request message for
BigtableInstanceAdmin.CreateInstance.

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 @@ -1176,7 +1173,6 @@ def __call__(
request (~.bigtable_instance_admin.DeleteAppProfileRequest):
The request object. Request message for
BigtableInstanceAdmin.DeleteAppProfile.

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 @@ -1254,7 +1250,6 @@ def __call__(
request (~.bigtable_instance_admin.DeleteClusterRequest):
The request object. Request message for
BigtableInstanceAdmin.DeleteCluster.

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 @@ -1330,7 +1325,6 @@ def __call__(
request (~.bigtable_instance_admin.DeleteInstanceRequest):
The request object. Request message for
BigtableInstanceAdmin.DeleteInstance.

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 @@ -1406,7 +1400,6 @@ def __call__(
request (~.bigtable_instance_admin.GetAppProfileRequest):
The request object. Request message for
BigtableInstanceAdmin.GetAppProfile.

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 @@ -1497,7 +1490,6 @@ def __call__(
request (~.bigtable_instance_admin.GetClusterRequest):
The request object. Request message for
BigtableInstanceAdmin.GetCluster.

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 @@ -1759,7 +1751,6 @@ def __call__(
request (~.bigtable_instance_admin.GetInstanceRequest):
The request object. Request message for
BigtableInstanceAdmin.GetInstance.

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 @@ -1853,7 +1844,6 @@ def __call__(
request (~.bigtable_instance_admin.ListAppProfilesRequest):
The request object. Request message for
BigtableInstanceAdmin.ListAppProfiles.

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 @@ -1945,7 +1935,6 @@ def __call__(
request (~.bigtable_instance_admin.ListClustersRequest):
The request object. Request message for
BigtableInstanceAdmin.ListClusters.

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 @@ -2035,7 +2024,6 @@ def __call__(
request (~.bigtable_instance_admin.ListHotTabletsRequest):
The request object. Request message for
BigtableInstanceAdmin.ListHotTablets.

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 @@ -2127,7 +2115,6 @@ def __call__(
request (~.bigtable_instance_admin.ListInstancesRequest):
The request object. Request message for
BigtableInstanceAdmin.ListInstances.

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 @@ -2219,7 +2206,6 @@ def __call__(
request (~.bigtable_instance_admin.PartialUpdateClusterRequest):
The request object. Request message for
BigtableInstanceAdmin.PartialUpdateCluster.

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 @@ -2321,7 +2307,6 @@ def __call__(
request (~.bigtable_instance_admin.PartialUpdateInstanceRequest):
The request object. Request message for
BigtableInstanceAdmin.PartialUpdateInstance.

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 @@ -2692,7 +2677,6 @@ def __call__(
request (~.bigtable_instance_admin.UpdateAppProfileRequest):
The request object. Request message for
BigtableInstanceAdmin.UpdateAppProfile.

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 @@ -2784,7 +2768,6 @@ def __call__(
location, capable of serving all
[Tables][google.bigtable.admin.v2.Table] in the parent
[Instance][google.bigtable.admin.v2.Instance].

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 @@ -2885,7 +2868,6 @@ def __call__(
served from all
[Clusters][google.bigtable.admin.v2.Cluster] in the
instance.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
14 changes: 8 additions & 6 deletions google/cloud/bigtable_admin_v2/services/bigtable_table_admin/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,7 @@ async def create_table_from_snapshot(
request (Optional[Union[google.cloud.bigtable_admin_v2.types.CreateTableFromSnapshotRequest, dict]]):
The request object. Request message for
[google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot]

Note: This is a private alpha release of Cloud Bigtable
snapshots. This feature is not currently available to
most Cloud Bigtable customers. This feature might be
Expand Down Expand Up @@ -1300,6 +1301,7 @@ async def snapshot_table(
request (Optional[Union[google.cloud.bigtable_admin_v2.types.SnapshotTableRequest, dict]]):
The request object. Request message for
[google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable]

Note: This is a private alpha release of Cloud Bigtable
snapshots. This feature is not currently available to
most Cloud Bigtable customers. This feature might be
Expand Down Expand Up @@ -1437,6 +1439,7 @@ async def get_snapshot(
request (Optional[Union[google.cloud.bigtable_admin_v2.types.GetSnapshotRequest, dict]]):
The request object. Request message for
[google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot]

Note: This is a private alpha release of Cloud Bigtable
snapshots. This feature is not currently available to
most Cloud Bigtable customers. This feature might be
Expand Down Expand Up @@ -1549,6 +1552,7 @@ async def list_snapshots(
request (Optional[Union[google.cloud.bigtable_admin_v2.types.ListSnapshotsRequest, dict]]):
The request object. Request message for
[google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]

Note: This is a private alpha release of Cloud Bigtable
snapshots. This feature is not currently available to
most Cloud Bigtable customers. This feature might be
Expand Down Expand Up @@ -1672,6 +1676,7 @@ async def delete_snapshot(
request (Optional[Union[google.cloud.bigtable_admin_v2.types.DeleteSnapshotRequest, dict]]):
The request object. Request message for
[google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot]

Note: This is a private alpha release of Cloud Bigtable
snapshots. This feature is not currently available to
most Cloud Bigtable customers. This feature might be
Expand Down Expand Up @@ -2290,8 +2295,7 @@ async def 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.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -2440,8 +2444,7 @@ async def 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.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -2581,8 +2584,7 @@ async def 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.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
14 changes: 8 additions & 6 deletions google/cloud/bigtable_admin_v2/services/bigtable_table_admin/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -696,6 +696,7 @@ def create_table_from_snapshot(
request (Union[google.cloud.bigtable_admin_v2.types.CreateTableFromSnapshotRequest, dict]):
The request object. Request message for
[google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot]

Note: This is a private alpha release of Cloud Bigtable
snapshots. This feature is not currently available to
most Cloud Bigtable customers. This feature might be
Expand Down Expand Up @@ -1594,6 +1595,7 @@ def snapshot_table(
request (Union[google.cloud.bigtable_admin_v2.types.SnapshotTableRequest, dict]):
The request object. Request message for
[google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable]

Note: This is a private alpha release of Cloud Bigtable
snapshots. This feature is not currently available to
most Cloud Bigtable customers. This feature might be
Expand Down Expand Up @@ -1731,6 +1733,7 @@ def get_snapshot(
request (Union[google.cloud.bigtable_admin_v2.types.GetSnapshotRequest, dict]):
The request object. Request message for
[google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot]

Note: This is a private alpha release of Cloud Bigtable
snapshots. This feature is not currently available to
most Cloud Bigtable customers. This feature might be
Expand Down Expand Up @@ -1833,6 +1836,7 @@ def list_snapshots(
request (Union[google.cloud.bigtable_admin_v2.types.ListSnapshotsRequest, dict]):
The request object. Request message for
[google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]

Note: This is a private alpha release of Cloud Bigtable
snapshots. This feature is not currently available to
most Cloud Bigtable customers. This feature might be
Expand Down Expand Up @@ -1946,6 +1950,7 @@ def delete_snapshot(
request (Union[google.cloud.bigtable_admin_v2.types.DeleteSnapshotRequest, dict]):
The request object. Request message for
[google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot]

Note: This is a private alpha release of Cloud Bigtable
snapshots. This feature is not currently available to
most Cloud Bigtable customers. This feature might be
Expand Down Expand Up @@ -2545,8 +2550,7 @@ def 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.
resource (str):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -2682,8 +2686,7 @@ def 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.
resource (str):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -2820,8 +2823,7 @@ def 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.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down
Loading