Skip to content

Commit

Permalink
docs: Fix formatting of request arg in docstring (#512)
Browse files Browse the repository at this point in the history
* 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[bot] and gcf-owl-bot[bot] authored Mar 23, 2023
1 parent 06d5337 commit 96c0657
Show file tree
Hide file tree
Showing 15 changed files with 130 additions and 176 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -259,8 +259,8 @@ async def sample_create_phrase_set():
Args:
request (Optional[Union[google.cloud.speech_v1.types.CreatePhraseSetRequest, dict]]):
The request object. Message sent by the client for the
`CreatePhraseSet` method.
The request object. Message sent by the client for the ``CreatePhraseSet``
method.
parent (:class:`str`):
Required. The parent resource where this phrase set will
be created. Format:
Expand Down Expand Up @@ -396,8 +396,8 @@ async def sample_get_phrase_set():
Args:
request (Optional[Union[google.cloud.speech_v1.types.GetPhraseSetRequest, dict]]):
The request object. Message sent by the client for the
`GetPhraseSet` method.
The request object. Message sent by the client for the ``GetPhraseSet``
method.
name (:class:`str`):
Required. The name of the phrase set to retrieve.
Format:
Expand Down Expand Up @@ -512,8 +512,8 @@ async def sample_list_phrase_set():
Args:
request (Optional[Union[google.cloud.speech_v1.types.ListPhraseSetRequest, dict]]):
The request object. Message sent by the client for the
`ListPhraseSet` method.
The request object. Message sent by the client for the ``ListPhraseSet``
method.
parent (:class:`str`):
Required. The parent, which owns this collection of
phrase set. Format:
Expand Down Expand Up @@ -638,8 +638,8 @@ async def sample_update_phrase_set():
Args:
request (Optional[Union[google.cloud.speech_v1.types.UpdatePhraseSetRequest, dict]]):
The request object. Message sent by the client for the
`UpdatePhraseSet` method.
The request object. Message sent by the client for the ``UpdatePhraseSet``
method.
phrase_set (:class:`google.cloud.speech_v1.types.PhraseSet`):
Required. The phrase set to update.
Expand Down Expand Up @@ -761,8 +761,8 @@ async def sample_delete_phrase_set():
Args:
request (Optional[Union[google.cloud.speech_v1.types.DeletePhraseSetRequest, dict]]):
The request object. Message sent by the client for the
`DeletePhraseSet` method.
The request object. Message sent by the client for the ``DeletePhraseSet``
method.
name (:class:`str`):
Required. The name of the phrase set to delete. Format:
Expand Down Expand Up @@ -860,8 +860,8 @@ async def sample_create_custom_class():
Args:
request (Optional[Union[google.cloud.speech_v1.types.CreateCustomClassRequest, dict]]):
The request object. Message sent by the client for the
`CreateCustomClass` method.
The request object. Message sent by the client for the ``CreateCustomClass``
method.
parent (:class:`str`):
Required. The parent resource where this custom class
will be created. Format:
Expand Down Expand Up @@ -1001,8 +1001,8 @@ async def sample_get_custom_class():
Args:
request (Optional[Union[google.cloud.speech_v1.types.GetCustomClassRequest, dict]]):
The request object. Message sent by the client for the
`GetCustomClass` method.
The request object. Message sent by the client for the ``GetCustomClass``
method.
name (:class:`str`):
Required. The name of the custom class to retrieve.
Format:
Expand Down Expand Up @@ -1113,8 +1113,8 @@ async def sample_list_custom_classes():
Args:
request (Optional[Union[google.cloud.speech_v1.types.ListCustomClassesRequest, dict]]):
The request object. Message sent by the client for the
`ListCustomClasses` method.
The request object. Message sent by the client for the ``ListCustomClasses``
method.
parent (:class:`str`):
Required. The parent, which owns this collection of
custom classes. Format:
Expand Down Expand Up @@ -1239,8 +1239,8 @@ async def sample_update_custom_class():
Args:
request (Optional[Union[google.cloud.speech_v1.types.UpdateCustomClassRequest, dict]]):
The request object. Message sent by the client for the
`UpdateCustomClass` method.
The request object. Message sent by the client for the ``UpdateCustomClass``
method.
custom_class (:class:`google.cloud.speech_v1.types.CustomClass`):
Required. The custom class to update.
Expand Down Expand Up @@ -1366,8 +1366,8 @@ async def sample_delete_custom_class():
Args:
request (Optional[Union[google.cloud.speech_v1.types.DeleteCustomClassRequest, dict]]):
The request object. Message sent by the client for the
`DeleteCustomClass` method.
The request object. Message sent by the client for the ``DeleteCustomClass``
method.
name (:class:`str`):
Required. The name of the custom class to delete.
Format:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -512,8 +512,8 @@ def sample_create_phrase_set():
Args:
request (Union[google.cloud.speech_v1.types.CreatePhraseSetRequest, dict]):
The request object. Message sent by the client for the
`CreatePhraseSet` method.
The request object. Message sent by the client for the ``CreatePhraseSet``
method.
parent (str):
Required. The parent resource where this phrase set will
be created. Format:
Expand Down Expand Up @@ -649,8 +649,8 @@ def sample_get_phrase_set():
Args:
request (Union[google.cloud.speech_v1.types.GetPhraseSetRequest, dict]):
The request object. Message sent by the client for the
`GetPhraseSet` method.
The request object. Message sent by the client for the ``GetPhraseSet``
method.
name (str):
Required. The name of the phrase set to retrieve.
Format:
Expand Down Expand Up @@ -765,8 +765,8 @@ def sample_list_phrase_set():
Args:
request (Union[google.cloud.speech_v1.types.ListPhraseSetRequest, dict]):
The request object. Message sent by the client for the
`ListPhraseSet` method.
The request object. Message sent by the client for the ``ListPhraseSet``
method.
parent (str):
Required. The parent, which owns this collection of
phrase set. Format:
Expand Down Expand Up @@ -891,8 +891,8 @@ def sample_update_phrase_set():
Args:
request (Union[google.cloud.speech_v1.types.UpdatePhraseSetRequest, dict]):
The request object. Message sent by the client for the
`UpdatePhraseSet` method.
The request object. Message sent by the client for the ``UpdatePhraseSet``
method.
phrase_set (google.cloud.speech_v1.types.PhraseSet):
Required. The phrase set to update.
Expand Down Expand Up @@ -1014,8 +1014,8 @@ def sample_delete_phrase_set():
Args:
request (Union[google.cloud.speech_v1.types.DeletePhraseSetRequest, dict]):
The request object. Message sent by the client for the
`DeletePhraseSet` method.
The request object. Message sent by the client for the ``DeletePhraseSet``
method.
name (str):
Required. The name of the phrase set to delete. Format:
Expand Down Expand Up @@ -1113,8 +1113,8 @@ def sample_create_custom_class():
Args:
request (Union[google.cloud.speech_v1.types.CreateCustomClassRequest, dict]):
The request object. Message sent by the client for the
`CreateCustomClass` method.
The request object. Message sent by the client for the ``CreateCustomClass``
method.
parent (str):
Required. The parent resource where this custom class
will be created. Format:
Expand Down Expand Up @@ -1254,8 +1254,8 @@ def sample_get_custom_class():
Args:
request (Union[google.cloud.speech_v1.types.GetCustomClassRequest, dict]):
The request object. Message sent by the client for the
`GetCustomClass` method.
The request object. Message sent by the client for the ``GetCustomClass``
method.
name (str):
Required. The name of the custom class to retrieve.
Format:
Expand Down Expand Up @@ -1366,8 +1366,8 @@ def sample_list_custom_classes():
Args:
request (Union[google.cloud.speech_v1.types.ListCustomClassesRequest, dict]):
The request object. Message sent by the client for the
`ListCustomClasses` method.
The request object. Message sent by the client for the ``ListCustomClasses``
method.
parent (str):
Required. The parent, which owns this collection of
custom classes. Format:
Expand Down Expand Up @@ -1492,8 +1492,8 @@ def sample_update_custom_class():
Args:
request (Union[google.cloud.speech_v1.types.UpdateCustomClassRequest, dict]):
The request object. Message sent by the client for the
`UpdateCustomClass` method.
The request object. Message sent by the client for the ``UpdateCustomClass``
method.
custom_class (google.cloud.speech_v1.types.CustomClass):
Required. The custom class to update.
Expand Down Expand Up @@ -1619,8 +1619,8 @@ def sample_delete_custom_class():
Args:
request (Union[google.cloud.speech_v1.types.DeleteCustomClassRequest, dict]):
The request object. Message sent by the client for the
`DeleteCustomClass` method.
The request object. Message sent by the client for the ``DeleteCustomClass``
method.
name (str):
Required. The name of the custom class to delete.
Format:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,6 @@ def __call__(
request (~.cloud_speech_adaptation.CreateCustomClassRequest):
The request object. Message sent by the client for the ``CreateCustomClass``
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 @@ -646,7 +645,6 @@ def __call__(
request (~.cloud_speech_adaptation.CreatePhraseSetRequest):
The request object. Message sent by the client for the ``CreatePhraseSet``
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 @@ -748,7 +746,6 @@ def __call__(
request (~.cloud_speech_adaptation.DeleteCustomClassRequest):
The request object. Message sent by the client for the ``DeleteCustomClass``
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 @@ -826,7 +823,6 @@ def __call__(
request (~.cloud_speech_adaptation.DeletePhraseSetRequest):
The request object. Message sent by the client for the ``DeletePhraseSet``
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 @@ -904,7 +900,6 @@ def __call__(
request (~.cloud_speech_adaptation.GetCustomClassRequest):
The request object. Message sent by the client for the ``GetCustomClass``
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 @@ -1001,7 +996,6 @@ def __call__(
request (~.cloud_speech_adaptation.GetPhraseSetRequest):
The request object. Message sent by the client for the ``GetPhraseSet``
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 @@ -1092,7 +1086,6 @@ def __call__(
request (~.cloud_speech_adaptation.ListCustomClassesRequest):
The request object. Message sent by the client for the ``ListCustomClasses``
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 @@ -1184,7 +1177,6 @@ def __call__(
request (~.cloud_speech_adaptation.ListPhraseSetRequest):
The request object. Message sent by the client for the ``ListPhraseSet``
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 @@ -1274,7 +1266,6 @@ def __call__(
request (~.cloud_speech_adaptation.UpdateCustomClassRequest):
The request object. Message sent by the client for the ``UpdateCustomClass``
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 @@ -1380,7 +1371,6 @@ def __call__(
request (~.cloud_speech_adaptation.UpdatePhraseSetRequest):
The request object. Message sent by the client for the ``UpdatePhraseSet``
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
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,8 @@ async def sample_recognize():
Args:
request (Optional[Union[google.cloud.speech_v1.types.RecognizeRequest, dict]]):
The request object. The top-level message sent by the
client for the `Recognize` method.
The request object. The top-level message sent by the client for the
``Recognize`` method.
config (:class:`google.cloud.speech_v1.types.RecognitionConfig`):
Required. Provides information to the
recognizer that specifies how to process
Expand Down Expand Up @@ -394,8 +394,8 @@ async def sample_long_running_recognize():
Args:
request (Optional[Union[google.cloud.speech_v1.types.LongRunningRecognizeRequest, dict]]):
The request object. The top-level message sent by the
client for the `LongRunningRecognize` method.
The request object. The top-level message sent by the client for the
``LongRunningRecognize`` method.
config (:class:`google.cloud.speech_v1.types.RecognitionConfig`):
Required. Provides information to the
recognizer that specifies how to process
Expand Down Expand Up @@ -531,13 +531,13 @@ def request_generator():
Args:
requests (AsyncIterator[`google.cloud.speech_v1.types.StreamingRecognizeRequest`]):
The request object AsyncIterator. The top-level message sent by the
client for the `StreamingRecognize` method. Multiple
`StreamingRecognizeRequest` messages are sent. The first
message must contain a `streaming_config` message and
must not contain `audio_content`. All subsequent
messages must contain `audio_content` and must not
contain a `streaming_config` message.
The request object AsyncIterator. The top-level message sent by the client for the
``StreamingRecognize`` method. Multiple
``StreamingRecognizeRequest`` messages are sent. The
first message must contain a ``streaming_config``
message and must not contain ``audio_content``. All
subsequent messages must contain ``audio_content`` and
must not contain a ``streaming_config`` 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
Original file line number Diff line number Diff line change
Expand Up @@ -516,8 +516,8 @@ def sample_recognize():
Args:
request (Union[google.cloud.speech_v1.types.RecognizeRequest, dict]):
The request object. The top-level message sent by the
client for the `Recognize` method.
The request object. The top-level message sent by the client for the
``Recognize`` method.
config (google.cloud.speech_v1.types.RecognitionConfig):
Required. Provides information to the
recognizer that specifies how to process
Expand Down Expand Up @@ -640,8 +640,8 @@ def sample_long_running_recognize():
Args:
request (Union[google.cloud.speech_v1.types.LongRunningRecognizeRequest, dict]):
The request object. The top-level message sent by the
client for the `LongRunningRecognize` method.
The request object. The top-level message sent by the client for the
``LongRunningRecognize`` method.
config (google.cloud.speech_v1.types.RecognitionConfig):
Required. Provides information to the
recognizer that specifies how to process
Expand Down Expand Up @@ -775,13 +775,13 @@ def request_generator():
Args:
requests (Iterator[google.cloud.speech_v1.types.StreamingRecognizeRequest]):
The request object iterator. The top-level message sent by the
client for the `StreamingRecognize` method. Multiple
`StreamingRecognizeRequest` messages are sent. The first
message must contain a `streaming_config` message and
must not contain `audio_content`. All subsequent
messages must contain `audio_content` and must not
contain a `streaming_config` message.
The request object iterator. The top-level message sent by the client for the
``StreamingRecognize`` method. Multiple
``StreamingRecognizeRequest`` messages are sent. The
first message must contain a ``streaming_config``
message and must not contain ``audio_content``. All
subsequent messages must contain ``audio_content`` and
must not contain a ``streaming_config`` 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 96c0657

Please sign in to comment.