diff --git a/samples/snippets/v3/cloud-client/README.rst b/samples/snippets/v3/cloud-client/README.rst index 18d2accc..280f9c4e 100644 --- a/samples/snippets/v3/cloud-client/README.rst +++ b/samples/snippets/v3/cloud-client/README.rst @@ -16,6 +16,14 @@ This directory contains samples for Google Stackdriver Monitoring API. Stackdriv .. _Google Stackdriver Monitoring API: https://cloud.google.com/monitoring/docs/ +To run the sample, you need to enable the API at: https://console.cloud.google.com/apis/library/monitoring.googleapis.com + +To run the sample, you need to have `Monitoring Admin` role. + + +Please visit [the Cloud Console UI of this API](https://console.cloud.google.com/monitoring) and create a new Workspace with the same name of your Cloud project. + + Setup ------------------------------------------------------------------------------- diff --git a/samples/snippets/v3/cloud-client/README.rst.in b/samples/snippets/v3/cloud-client/README.rst.in index d6a0dd46..0ab6b225 100644 --- a/samples/snippets/v3/cloud-client/README.rst.in +++ b/samples/snippets/v3/cloud-client/README.rst.in @@ -12,6 +12,13 @@ product: and many others. Stackdriver ingests that data and generates insights via dashboards, charts, and alerts. +required_api_url: https://console.cloud.google.com/apis/library/monitoring.googleapis.com +required_role: Monitoring Admin +other_required_steps: > + Please visit [the Cloud Console UI of this + API](https://console.cloud.google.com/monitoring) and create a new + Workspace with the same name of your Cloud project. + setup: - auth - install_deps @@ -25,4 +32,4 @@ samples: cloud_client_library: true -folder: monitoring/api/v3/cloud-client \ No newline at end of file +folder: monitoring/api/v3/cloud-client diff --git a/samples/snippets/v3/cloud-client/noxfile_config.py b/samples/snippets/v3/cloud-client/noxfile_config.py new file mode 100644 index 00000000..6dc47110 --- /dev/null +++ b/samples/snippets/v3/cloud-client/noxfile_config.py @@ -0,0 +1,42 @@ +# 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. + +# Default TEST_CONFIG_OVERRIDE for python repos. + +# You can copy this file into your directory, then it will be inported from +# the noxfile.py. + +# The source of truth: +# https://github.com/GoogleCloudPlatform/python-docs-samples/blob/master/noxfile_config.py + +TEST_CONFIG_OVERRIDE = { + # You can opt out from the test for specific Python versions. + 'ignored_versions': ["2.7"], + + # Declare optional test sessions you want to opt-in. Currently we + # have the following optional test sessions: + # 'cloud_run' # Test session for Cloud Run application. + 'opt_in_sessions': [], + + # An envvar key for determining the project id to use. Change it + # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a + # build specific Cloud project. You can also use your own string + # to use your own Cloud project. + # 'gcloud_project_env': 'GCLOUD_PROJECT', + 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT', + + # A dictionary you want to inject into your test. Don't put any + # secrets here. These values will override predefined values. + 'envs': {}, +}