-
Notifications
You must be signed in to change notification settings - Fork 6.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add example of creating AutoML Tables client with non-default endpoint ('new' sdk) #3929
Merged
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
3fac148
add example of creating client with non-default endpoint
amygdala 2ff0478
more test file cleanup
amygdala 6907658
Merge branch 'master' into endpoint
amygdala 80d2473
move connectivity print stmt out of test fn
amygdala 9a1edbe
Merge branch 'master' into endpoint
leahecole 6d250d2
Merge branch 'master' into endpoint
leahecole d89e7c8
Merge branch 'master' into endpoint
sirtorry d50cc94
Merge branch 'master' into endpoint
leahecole File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Copyright 2020 Google LLC | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
|
||
def create_client_with_endpoint(gcp_project_id): | ||
"""Create a Tables client with a non-default endpoint.""" | ||
# [START automl_set_endpoint] | ||
from google.cloud import automl_v1beta1 as automl | ||
from google.api_core.client_options import ClientOptions | ||
|
||
# Set the endpoint you want to use via the ClientOptions. | ||
# gcp_project_id = 'YOUR_PROJECT_ID' | ||
client_options = ClientOptions(api_endpoint="eu-automl.googleapis.com:443") | ||
client = automl.TablesClient( | ||
project=gcp_project_id, region="eu", client_options=client_options | ||
) | ||
# [END automl_set_endpoint] | ||
|
||
return client |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
#!/usr/bin/env python | ||
|
||
# Copyright 2020 Google LLC | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
import os | ||
|
||
import automl_tables_set_endpoint | ||
|
||
PROJECT = os.environ["GCLOUD_PROJECT"] | ||
|
||
|
||
def test_client_creation(capsys): | ||
client = automl_tables_set_endpoint.create_client_with_endpoint(PROJECT) | ||
print(client.list_datasets()) | ||
out, _ = capsys.readouterr() | ||
assert "GRPCIterator" in out | ||
dinagraves marked this conversation as resolved.
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be possible to have the
create_client_with_endpoint
method print something, and then assert on your print? Then, you would be testing your sample, rather than the actual AutoML underlying function.Also, if testing is something you're not 100% comfortable with, do feel free to put some time on my calendar and we can take 20-30 min to have a faster back and forth about what you think is most appropriate for this sample :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 to @leahecole 's suggestion.
For the set endpoint kind of samples, we typically use a really simple API call to verify that the client was created and operates correctly.
See example here.
I suggest copying the output of the regular Tables list_datasets sample.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this case, no need to check anything re: the 'list_datasets' output specifics. There may or may not be any defined, but the details aren't relevant here. (I picked that call arbitrarily as a simple connectivity check, so I don't think that sample is particularly relevant).
In fact, I think we can remove an assertion on the output altogether-- if the call fails, it will throw an exception, which will fail the test. Would you prefer the test explicitly catch the exception + then raise an error, or just let it be thrown?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 to just executing
list_datasets
since the goal is to check that the client was constructed correctly.