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.

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

docs: Fix formatting of request arg in docstring #734

Merged
merged 2 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ async def sample_list_buckets():

Args:
request (Optional[Union[google.cloud.logging_v2.types.ListBucketsRequest, dict]]):
The request object. The parameters to `ListBuckets`.
The request object. The parameters to ``ListBuckets``.
parent (:class:`str`):
Required. The parent resource whose buckets are to be
listed:
Expand Down Expand Up @@ -393,7 +393,7 @@ async def sample_get_bucket():

Args:
request (Optional[Union[google.cloud.logging_v2.types.GetBucketRequest, dict]]):
The request object. The parameters to `GetBucket`.
The request object. The parameters to ``GetBucket``.
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 @@ -475,7 +475,7 @@ async def sample_create_bucket():

Args:
request (Optional[Union[google.cloud.logging_v2.types.CreateBucketRequest, dict]]):
The request object. The parameters to `CreateBucket`.
The request object. The parameters to ``CreateBucket``.
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 @@ -565,7 +565,7 @@ async def sample_update_bucket():

Args:
request (Optional[Union[google.cloud.logging_v2.types.UpdateBucketRequest, dict]]):
The request object. The parameters to `UpdateBucket`.
The request object. The parameters to ``UpdateBucket``.
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 @@ -646,7 +646,7 @@ async def sample_delete_bucket():

Args:
request (Optional[Union[google.cloud.logging_v2.types.DeleteBucketRequest, dict]]):
The request object. The parameters to `DeleteBucket`.
The request object. The parameters to ``DeleteBucket``.
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 @@ -715,7 +715,7 @@ async def sample_undelete_bucket():

Args:
request (Optional[Union[google.cloud.logging_v2.types.UndeleteBucketRequest, dict]]):
The request object. The parameters to `UndeleteBucket`.
The request object. The parameters to ``UndeleteBucket``.
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 @@ -787,7 +787,7 @@ async def sample_list_views():

Args:
request (Optional[Union[google.cloud.logging_v2.types.ListViewsRequest, dict]]):
The request object. The parameters to `ListViews`.
The request object. The parameters to ``ListViews``.
parent (:class:`str`):
Required. The bucket whose views are to be listed:

Expand Down Expand Up @@ -901,7 +901,7 @@ async def sample_get_view():

Args:
request (Optional[Union[google.cloud.logging_v2.types.GetViewRequest, dict]]):
The request object. The parameters to `GetView`.
The request object. The parameters to ``GetView``.
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 @@ -982,7 +982,7 @@ async def sample_create_view():

Args:
request (Optional[Union[google.cloud.logging_v2.types.CreateViewRequest, dict]]):
The request object. The parameters to `CreateView`.
The request object. The parameters to ``CreateView``.
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 @@ -1065,7 +1065,7 @@ async def sample_update_view():

Args:
request (Optional[Union[google.cloud.logging_v2.types.UpdateViewRequest, dict]]):
The request object. The parameters to `UpdateView`.
The request object. The parameters to ``UpdateView``.
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 @@ -1144,7 +1144,7 @@ async def sample_delete_view():

Args:
request (Optional[Union[google.cloud.logging_v2.types.DeleteViewRequest, dict]]):
The request object. The parameters to `DeleteView`.
The request object. The parameters to ``DeleteView``.
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 @@ -1216,7 +1216,7 @@ async def sample_list_sinks():

Args:
request (Optional[Union[google.cloud.logging_v2.types.ListSinksRequest, dict]]):
The request object. The parameters to `ListSinks`.
The request object. The parameters to ``ListSinks``.
parent (:class:`str`):
Required. The parent resource whose sinks are to be
listed:
Expand Down Expand Up @@ -1346,7 +1346,7 @@ async def sample_get_sink():

Args:
request (Optional[Union[google.cloud.logging_v2.types.GetSinkRequest, dict]]):
The request object. The parameters to `GetSink`.
The request object. The parameters to ``GetSink``.
sink_name (:class:`str`):
Required. The resource name of the sink:

Expand Down Expand Up @@ -1487,7 +1487,7 @@ async def sample_create_sink():

Args:
request (Optional[Union[google.cloud.logging_v2.types.CreateSinkRequest, dict]]):
The request object. The parameters to `CreateSink`.
The request object. The parameters to ``CreateSink``.
parent (:class:`str`):
Required. The resource in which to create the sink:

Expand Down Expand Up @@ -1626,7 +1626,7 @@ async def sample_update_sink():

Args:
request (Optional[Union[google.cloud.logging_v2.types.UpdateSinkRequest, dict]]):
The request object. The parameters to `UpdateSink`.
The request object. The parameters to ``UpdateSink``.
sink_name (:class:`str`):
Required. The full resource name of the sink to update,
including the parent resource and the sink identifier:
Expand Down Expand Up @@ -1789,7 +1789,7 @@ async def sample_delete_sink():

Args:
request (Optional[Union[google.cloud.logging_v2.types.DeleteSinkRequest, dict]]):
The request object. The parameters to `DeleteSink`.
The request object. The parameters to ``DeleteSink``.
sink_name (:class:`str`):
Required. The full resource name of the sink to delete,
including the parent resource and the sink identifier:
Expand Down Expand Up @@ -1907,7 +1907,7 @@ async def sample_list_exclusions():

Args:
request (Optional[Union[google.cloud.logging_v2.types.ListExclusionsRequest, dict]]):
The request object. The parameters to `ListExclusions`.
The request object. The parameters to ``ListExclusions``.
parent (:class:`str`):
Required. The parent resource whose exclusions are to be
listed.
Expand Down Expand Up @@ -2037,7 +2037,7 @@ async def sample_get_exclusion():

Args:
request (Optional[Union[google.cloud.logging_v2.types.GetExclusionRequest, dict]]):
The request object. The parameters to `GetExclusion`.
The request object. The parameters to ``GetExclusion``.
name (:class:`str`):
Required. The resource name of an existing exclusion:

Expand Down Expand Up @@ -2172,7 +2172,7 @@ async def sample_create_exclusion():

Args:
request (Optional[Union[google.cloud.logging_v2.types.CreateExclusionRequest, dict]]):
The request object. The parameters to `CreateExclusion`.
The request object. The parameters to ``CreateExclusion``.
parent (:class:`str`):
Required. The parent resource in which to create the
exclusion:
Expand Down Expand Up @@ -2308,7 +2308,7 @@ async def sample_update_exclusion():

Args:
request (Optional[Union[google.cloud.logging_v2.types.UpdateExclusionRequest, dict]]):
The request object. The parameters to `UpdateExclusion`.
The request object. The parameters to ``UpdateExclusion``.
name (:class:`str`):
Required. The resource name of the exclusion to update:

Expand Down Expand Up @@ -2447,7 +2447,7 @@ async def sample_delete_exclusion():

Args:
request (Optional[Union[google.cloud.logging_v2.types.DeleteExclusionRequest, dict]]):
The request object. The parameters to `DeleteExclusion`.
The request object. The parameters to ``DeleteExclusion``.
name (:class:`str`):
Required. The resource name of an existing exclusion to
delete:
Expand Down Expand Up @@ -2571,8 +2571,9 @@ async def sample_get_cmek_settings():
request (Optional[Union[google.cloud.logging_v2.types.GetCmekSettingsRequest, dict]]):
The request object. The parameters to
[GetCmekSettings][google.logging.v2.ConfigServiceV2.GetCmekSettings].
See [Enabling CMEK for Log
Router](https://cloud.google.com/logging/docs/routing/managed-encryption)

See `Enabling CMEK for Log
Router <https://cloud.google.com/logging/docs/routing/managed-encryption>`__
for more information.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
Expand Down Expand Up @@ -2678,8 +2679,9 @@ async def sample_update_cmek_settings():
request (Optional[Union[google.cloud.logging_v2.types.UpdateCmekSettingsRequest, dict]]):
The request object. The parameters to
[UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings].
See [Enabling CMEK for Log
Router](https://cloud.google.com/logging/docs/routing/managed-encryption)

See `Enabling CMEK for Log
Router <https://cloud.google.com/logging/docs/routing/managed-encryption>`__
for more information.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
Expand Down Expand Up @@ -2782,8 +2784,9 @@ async def sample_get_settings():
request (Optional[Union[google.cloud.logging_v2.types.GetSettingsRequest, dict]]):
The request object. The parameters to
[GetSettings][google.logging.v2.ConfigServiceV2.GetSettings].
See [Enabling CMEK for Log
Router](https://cloud.google.com/logging/docs/routing/managed-encryption)

See `Enabling CMEK for Log
Router <https://cloud.google.com/logging/docs/routing/managed-encryption>`__
for more information.
name (:class:`str`):
Required. The resource for which to retrieve settings.
Expand Down Expand Up @@ -2923,8 +2926,9 @@ async def sample_update_settings():
request (Optional[Union[google.cloud.logging_v2.types.UpdateSettingsRequest, dict]]):
The request object. The parameters to
[UpdateSettings][google.logging.v2.ConfigServiceV2.UpdateSettings].
See [Enabling CMEK for Log
Router](https://cloud.google.com/logging/docs/routing/managed-encryption)

See `Enabling CMEK for Log
Router <https://cloud.google.com/logging/docs/routing/managed-encryption>`__
for more information.
settings (:class:`google.cloud.logging_v2.types.Settings`):
Required. The settings to update.
Expand Down
Loading