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

Provide sample codes on how to use methods #56

Closed
darwinyip opened this issue Nov 11, 2020 · 3 comments · Fixed by #144
Closed

Provide sample codes on how to use methods #56

darwinyip opened this issue Nov 11, 2020 · 3 comments · Fixed by #144
Assignees
@tswast
Labels
api: bigqueryreservation Issues related to the googleapis/python-bigquery-reservation API. samples Issues that are directly related to samples. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@darwinyip
Copy link

darwinyip commented Nov 11, 2020 •
edited

I'm reading through the documentation and it's very hard to navigate. There are no indications on how to use the classes.

For example, in update_reservation, what is the update_mask? Why is it needed? Why is there a request field? What is the difference between that and Reservation?
@product-auto-label product-auto-label bot added the api: bigqueryreservation Issues related to the googleapis/python-bigquery-reservation API. label Nov 11, 2020
@tswast
Copy link
Contributor

tswast commented Nov 11, 2020

👍 Thank you for the request. I agree that sample code would be useful for this API.

request is a common field across all generated clients. It's used for creating API requests that need a more complex body than is possible with the other keyword arguments. For many APIs this is not particularly relevant, but it's needed in case the API surface changes in the future.

@tswast tswast added the type: docs Improvement to the documentation for an API. label Nov 11, 2020
@product-auto-label product-auto-label bot added the samples Issues that are directly related to samples. label Dec 25, 2020
@tswast tswast self-assigned this Jan 6, 2021
@tswast tswast added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. and removed type: docs Improvement to the documentation for an API. labels Jun 30, 2021
@KevinTydlacka
Copy link

I also have had some trouble working with this library for the same reason. The source is a bit cumbersome to wade through just to figure out how to make a simple request or two. I'd specifically love to see some samples around the BI Engine endpoints/methods.

@tswast tswast mentioned this issue Aug 10, 2021
Merged
4 tasks
@tswast
Copy link
Contributor

tswast commented Aug 10, 2021

I've created code samples in #144

Once they're running in our CI infrastructure, I'll try to get these added as examples in the docs.

gcf-merge-on-green bot pushed a commit that referenced this issue Aug 13, 2021
@tswast
docs: samples for managing reservations (#144)
27b2564 
TODO: Testing these samples requires a capacity commitment. I created on manually on my dev project, but I think we'll want to programmatically create one in our CI project(s).

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-bigquery-reservation/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)

Fixes #56  🦕
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@tswast tswast

Labels
api: bigqueryreservation Issues related to the googleapis/python-bigquery-reservation API. samples Issues that are directly related to samples. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: samples for managing reservations tswast/python-bigquery-reservation
3 participants
@tswast @darwinyip @KevinTydlacka