Skip to content

feat: Add dataplane code snippets for feature store service#713

Merged
lclc19 merged 9 commits intogoogleapis:mainfrom
lclc19:lclc_snippet_part_2
Sep 24, 2021
Merged

feat: Add dataplane code snippets for feature store service#713
lclc19 merged 9 commits intogoogleapis:mainfrom
lclc19:lclc_snippet_part_2

Conversation

@lclc19
Copy link
Contributor

@lclc19 lclc19 commented Sep 16, 2021

This is a follow up PR for dataplane code snippets for feature store service

@lclc19 lclc19 requested review from a team as code owners September 16, 2021 19:52
@lclc19 lclc19 requested a review from dinagraves September 16, 2021 19:52
@product-auto-label product-auto-label bot added the api: aiplatform Issues related to the AI Platform API. label Sep 16, 2021
@snippet-bot
Copy link

snippet-bot bot commented Sep 16, 2021 •
edited
Loading

Here is the summary of changes.

You are about to add 4 region tags.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Sep 16, 2021
@lclc19 lclc19 force-pushed the lclc_snippet_part_2 branch from 4fce072 to a94f08b Compare September 16, 2021 22:17
@lclc19 lclc19 force-pushed the lclc_snippet_part_2 branch from 02bbd39 to 80e8c4d Compare September 16, 2021 23:15
@lclc19 lclc19 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Sep 17, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Sep 17, 2021
diemtvu
diemtvu reviewed Sep 17, 2021
View reviewed changes
@lclc19 lclc19 force-pushed the lclc_snippet_part_2 branch from 254e0a8 to 9dd3a7a Compare September 22, 2021 18:58
@lclc19
Copy link
Contributor Author

lclc19 commented Sep 22, 2021

Re guidance for parameters list:
Same as #713 (comment), we need to expose the request construction explicitly in order for the sample to be educational. We expect the usage for this snippet is that a user fill in all the parameters as seen in the function signature, then the snippet should work as expected, and the user can later tweak the hard coded part to fulfill their specialized use.

@nicain nicain self-requested a review September 22, 2021 19:39
nicain
nicain requested changes Sep 22, 2021
View reviewed changes
Copy link
Contributor

@nicain nicain left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Import dependencies
  • Instantiate the client library
  • Handle authentication
  • Prepare an API request
  • Exercise the API
  • Process the result
  • Use correct region tags
  • Region tags updated in cloud.google.com
  • Self-contained, copy-paste-runnable
  • Descriptive top-level comment
  • Code comments in the body of the code snippet
  • Lines of code (and 120 char lines)
  • Levels of indirection
  • Cyclomatic complexity
  • Variable instantiation
  • Variable types
  • Adhere to language idioms
  • Handle errors
  • Test coverage
  • Portable in multiple environments

@nicain nicain self-requested a review September 22, 2021 22:15
nicain
nicain approved these changes Sep 22, 2021
View reviewed changes
Copy link
Contributor

@nicain nicain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updates make this LGTM.

You may want to verify that your region tags are consistent with those in the documentation, I haven't checked those but don't want to block you.

@lclc19
Copy link
Contributor Author

lclc19 commented Sep 22, 2021

Updates make this LGTM.

You may want to verify that your region tags are consistent with those in the documentation, I haven't checked those but don't want to block you.

Thanks, double checked the region tags to make sure they are conforming to go/code-snippets-style#use-correct-region-tags

@lclc19 lclc19 merged commit e3ea683 into googleapis:main Sep 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nicain nicain nicain approved these changes

@dinagraves dinagraves Awaiting requested review from dinagraves

+1 more reviewer

@diemtvu diemtvu diemtvu left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

api: aiplatform Issues related to the AI Platform API. cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@lclc19 @nicain @diemtvu @yoshi-kokoro