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

docs: Fix formatting of request arg in docstring #296

Merged
merged 2 commits into from
Mar 23, 2023
Merged

docs: Fix formatting of request arg in docstring #296

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
edf7731
docs: Fix formatting of request arg in docstring
gcf-owl-bot[bot] Mar 22, 2023
e78c31d
🦉 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
23 changes: 10 additions & 13 deletions google/cloud/video/transcoder_v1/services/transcoder_service/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,7 @@ async def sample_create_job():

Args:
request (Optional[Union[google.cloud.video.transcoder_v1.types.CreateJobRequest, dict]]):
The request object. Request message for
`TranscoderService.CreateJob`.
The request object. Request message for ``TranscoderService.CreateJob``.
parent (:class:`str`):
Required. The parent location to create and process this
job. Format: ``projects/{project}/locations/{location}``
Expand Down Expand Up @@ -382,9 +381,9 @@ async def sample_list_jobs():

Args:
request (Optional[Union[google.cloud.video.transcoder_v1.types.ListJobsRequest, dict]]):
The request object. Request message for
`TranscoderService.ListJobs`. The parent location from
which to retrieve the collection of jobs.
The request object. Request message for ``TranscoderService.ListJobs``. The
parent location from which to retrieve the collection of
jobs.
parent (:class:`str`):
Required. Format:
``projects/{project}/locations/{location}``
Expand Down Expand Up @@ -496,8 +495,7 @@ async def sample_get_job():

Args:
request (Optional[Union[google.cloud.video.transcoder_v1.types.GetJobRequest, dict]]):
The request object. Request message for
`TranscoderService.GetJob`.
The request object. Request message for ``TranscoderService.GetJob``.
name (:class:`str`):
Required. The name of the job to retrieve. Format:
``projects/{project}/locations/{location}/jobs/{job}``
Expand Down Expand Up @@ -593,8 +591,7 @@ async def sample_delete_job():

Args:
request (Optional[Union[google.cloud.video.transcoder_v1.types.DeleteJobRequest, dict]]):
The request object. Request message for
`TranscoderService.DeleteJob`.
The request object. Request message for ``TranscoderService.DeleteJob``.
name (:class:`str`):
Required. The name of the job to delete. Format:
``projects/{project}/locations/{location}/jobs/{job}``
Expand Down Expand Up @@ -690,7 +687,7 @@ async def sample_create_job_template():
Args:
request (Optional[Union[google.cloud.video.transcoder_v1.types.CreateJobTemplateRequest, dict]]):
The request object. Request message for
`TranscoderService.CreateJobTemplate`.
``TranscoderService.CreateJobTemplate``.
parent (:class:`str`):
Required. The parent location to create this job
template. Format:
Expand Down Expand Up @@ -815,7 +812,7 @@ async def sample_list_job_templates():
Args:
request (Optional[Union[google.cloud.video.transcoder_v1.types.ListJobTemplatesRequest, dict]]):
The request object. Request message for
`TranscoderService.ListJobTemplates`.
``TranscoderService.ListJobTemplates``.
parent (:class:`str`):
Required. The parent location from which to retrieve the
collection of job templates. Format:
Expand Down Expand Up @@ -929,7 +926,7 @@ async def sample_get_job_template():
Args:
request (Optional[Union[google.cloud.video.transcoder_v1.types.GetJobTemplateRequest, dict]]):
The request object. Request message for
`TranscoderService.GetJobTemplate`.
``TranscoderService.GetJobTemplate``.
name (:class:`str`):
Required. The name of the job template to retrieve.
Format:
Expand Down Expand Up @@ -1027,7 +1024,7 @@ async def sample_delete_job_template():
Args:
request (Optional[Union[google.cloud.video.transcoder_v1.types.DeleteJobTemplateRequest, dict]]):
The request object. Request message for
`TranscoderService.DeleteJobTemplate`.
``TranscoderService.DeleteJobTemplate``.
name (:class:`str`):
Required. The name of the job template to delete.
``projects/{project}/locations/{location}/jobTemplates/{job_template}``
Expand Down
23 changes: 10 additions & 13 deletions google/cloud/video/transcoder_v1/services/transcoder_service/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,8 +519,7 @@ def sample_create_job():

Args:
request (Union[google.cloud.video.transcoder_v1.types.CreateJobRequest, dict]):
The request object. Request message for
`TranscoderService.CreateJob`.
The request object. Request message for ``TranscoderService.CreateJob``.
parent (str):
Required. The parent location to create and process this
job. Format: ``projects/{project}/locations/{location}``
Expand Down Expand Up @@ -629,9 +628,9 @@ def sample_list_jobs():

Args:
request (Union[google.cloud.video.transcoder_v1.types.ListJobsRequest, dict]):
The request object. Request message for
`TranscoderService.ListJobs`. The parent location from
which to retrieve the collection of jobs.
The request object. Request message for ``TranscoderService.ListJobs``. The
parent location from which to retrieve the collection of
jobs.
parent (str):
Required. Format:
``projects/{project}/locations/{location}``
Expand Down Expand Up @@ -743,8 +742,7 @@ def sample_get_job():

Args:
request (Union[google.cloud.video.transcoder_v1.types.GetJobRequest, dict]):
The request object. Request message for
`TranscoderService.GetJob`.
The request object. Request message for ``TranscoderService.GetJob``.
name (str):
Required. The name of the job to retrieve. Format:
``projects/{project}/locations/{location}/jobs/{job}``
Expand Down Expand Up @@ -840,8 +838,7 @@ def sample_delete_job():

Args:
request (Union[google.cloud.video.transcoder_v1.types.DeleteJobRequest, dict]):
The request object. Request message for
`TranscoderService.DeleteJob`.
The request object. Request message for ``TranscoderService.DeleteJob``.
name (str):
Required. The name of the job to delete. Format:
``projects/{project}/locations/{location}/jobs/{job}``
Expand Down Expand Up @@ -937,7 +934,7 @@ def sample_create_job_template():
Args:
request (Union[google.cloud.video.transcoder_v1.types.CreateJobTemplateRequest, dict]):
The request object. Request message for
`TranscoderService.CreateJobTemplate`.
``TranscoderService.CreateJobTemplate``.
parent (str):
Required. The parent location to create this job
template. Format:
Expand Down Expand Up @@ -1062,7 +1059,7 @@ def sample_list_job_templates():
Args:
request (Union[google.cloud.video.transcoder_v1.types.ListJobTemplatesRequest, dict]):
The request object. Request message for
`TranscoderService.ListJobTemplates`.
``TranscoderService.ListJobTemplates``.
parent (str):
Required. The parent location from which to retrieve the
collection of job templates. Format:
Expand Down Expand Up @@ -1176,7 +1173,7 @@ def sample_get_job_template():
Args:
request (Union[google.cloud.video.transcoder_v1.types.GetJobTemplateRequest, dict]):
The request object. Request message for
`TranscoderService.GetJobTemplate`.
``TranscoderService.GetJobTemplate``.
name (str):
Required. The name of the job template to retrieve.
Format:
Expand Down Expand Up @@ -1274,7 +1271,7 @@ def sample_delete_job_template():
Args:
request (Union[google.cloud.video.transcoder_v1.types.DeleteJobTemplateRequest, dict]):
The request object. Request message for
`TranscoderService.DeleteJobTemplate`.
``TranscoderService.DeleteJobTemplate``.
name (str):
Required. The name of the job template to delete.
``projects/{project}/locations/{location}/jobTemplates/{job_template}``
Expand Down
5 changes: 0 additions & 5 deletions google/cloud/video/transcoder_v1/services/transcoder_service/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,7 +505,6 @@ def __call__(
request (~.services.CreateJobTemplateRequest):
The request object. Request message for
``TranscoderService.CreateJobTemplate``.

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 @@ -678,7 +677,6 @@ def __call__(
request (~.services.DeleteJobTemplateRequest):
The request object. Request message for
``TranscoderService.DeleteJobTemplate``.

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 @@ -842,7 +840,6 @@ def __call__(
request (~.services.GetJobTemplateRequest):
The request object. Request message for
``TranscoderService.GetJobTemplate``.

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 @@ -933,7 +930,6 @@ def __call__(
The request object. Request message for ``TranscoderService.ListJobs``. The
parent location from which to retrieve the collection of
jobs.

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 @@ -1021,7 +1017,6 @@ def __call__(
request (~.services.ListJobTemplatesRequest):
The request object. Request message for
``TranscoderService.ListJobTemplates``.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
2 changes: 1 addition & 1 deletion samples/generated_samples/snippet_metadata_google.cloud.video.transcoder.v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-video-transcoder",
"version": "1.8.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down