Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

docs: Fix formatting of request arg in docstring #350

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 @@ -2505,6 +2505,7 @@ async def sample_move_assignment():
request (Optional[Union[google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest, dict]]):
The request object. The request for
[ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment].

**Note**: "bigquery.reservationAssignments.create"
permission is required on the destination_id.

Expand Down Expand Up @@ -2853,8 +2854,7 @@ async def sample_update_bi_reservation():

Args:
request (Optional[Union[google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest, dict]]):
The request object. A request to update a BI
reservation.
The request object. A request to update a BI reservation.
bi_reservation (:class:`google.cloud.bigquery_reservation_v1.types.BiReservation`):
A reservation to update.
This corresponds to the ``bi_reservation`` field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2709,6 +2709,7 @@ def sample_move_assignment():
request (Union[google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest, dict]):
The request object. The request for
[ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment].

**Note**: "bigquery.reservationAssignments.create"
permission is required on the destination_id.

Expand Down Expand Up @@ -3047,8 +3048,7 @@ def sample_update_bi_reservation():

Args:
request (Union[google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest, dict]):
The request object. A request to update a BI
reservation.
The request object. A request to update a BI reservation.
bi_reservation (google.cloud.bigquery_reservation_v1.types.BiReservation):
A reservation to update.
This corresponds to the ``bi_reservation`` field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -821,7 +821,6 @@ def __call__(
[ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment].
Note: "bigquery.reservationAssignments.create"
permission is required on the related assignee.

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 @@ -924,7 +923,6 @@ def __call__(
request (~.reservation.CreateCapacityCommitmentRequest):
The request object. The request for
[ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment].

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 @@ -1037,7 +1035,6 @@ def __call__(
request (~.gcbr_reservation.CreateReservationRequest):
The request object. The request for
[ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation].

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 @@ -1140,7 +1137,6 @@ def __call__(
[ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment].
Note: "bigquery.reservationAssignments.delete"
permission is required on the related assignee.

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 @@ -1219,7 +1215,6 @@ def __call__(
request (~.reservation.DeleteCapacityCommitmentRequest):
The request object. The request for
[ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment].

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 @@ -1297,7 +1292,6 @@ def __call__(
request (~.reservation.DeleteReservationRequest):
The request object. The request for
[ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation].

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 @@ -1375,7 +1369,6 @@ def __call__(
request (~.reservation.GetBiReservationRequest):
The request object. A request to get a singleton BI
reservation.

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 @@ -1465,7 +1458,6 @@ def __call__(
request (~.reservation.GetCapacityCommitmentRequest):
The request object. The request for
[ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment].

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 @@ -1569,7 +1561,6 @@ def __call__(
request (~.reservation.GetReservationRequest):
The request object. The request for
[ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation].

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 @@ -1659,7 +1650,6 @@ def __call__(
request (~.reservation.ListAssignmentsRequest):
The request object. The request for
[ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].

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 @@ -1751,7 +1741,6 @@ def __call__(
request (~.reservation.ListCapacityCommitmentsRequest):
The request object. The request for
[ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].

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 @@ -1843,7 +1832,6 @@ def __call__(
request (~.reservation.ListReservationsRequest):
The request object. The request for
[ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].

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 @@ -1926,7 +1914,6 @@ def __call__(
request (~.reservation.MergeCapacityCommitmentsRequest):
The request object. The request for
[ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments].

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 @@ -2045,7 +2032,6 @@ def __call__(
**Note**: "bigquery.reservationAssignments.create" and
"bigquery.reservationAssignments.delete" permission are
required on the related assignee.

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 @@ -2147,7 +2133,6 @@ def __call__(
[ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments].
Note: "bigquery.reservationAssignments.search"
permission is required on the related assignee.

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 @@ -2241,7 +2226,6 @@ def __call__(
[ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments].
Note: "bigquery.reservationAssignments.search"
permission is required on the related assignee.

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 @@ -2333,7 +2317,6 @@ def __call__(
request (~.reservation.SplitCapacityCommitmentRequest):
The request object. The request for
[ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].

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 @@ -2424,7 +2407,6 @@ def __call__(
request (~.reservation.UpdateAssignmentRequest):
The request object. The request for
[ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment].

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 @@ -2602,7 +2584,6 @@ def __call__(
request (~.reservation.UpdateCapacityCommitmentRequest):
The request object. The request for
[ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment].

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 @@ -2704,7 +2685,6 @@ def __call__(
request (~.gcbr_reservation.UpdateReservationRequest):
The request object. The request for
[ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation].

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down