feat: adding samples for default values

Featuring the usage report API.
m-strzelczyk · Jun 29, 2021 · Jun 15, 2021 · Jun 17, 2021 · Jun 22, 2021 · Jun 25, 2021
commit a36d7d6122d7fb6b16bec4a014e74ad394705f50
diff --git a/samples/snippets/sample_default_values.py b/samples/snippets/sample_default_values.py
@@ -0,0 +1,114 @@
+#!/usr/bin/env python
+
+# Copyright 2021 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.
+"""
+A sample script showing how to handle default values when communicating
+with the Compute Engine API.
+"""
+# [START compute_instances_verify_default_value]
+# [START compute_usage_report_set]
+# [START compute_usage_report_get]
+# [START compute_usage_report_disable]
+from google.cloud import compute_v1
+# [END compute_usage_report_disable]
+# [END compute_usage_report_get]
+# [END compute_usage_report_set]
+
+
+# [START compute_usage_report_set]
+def set_usage_export_bucket(project_id: str, bucket_name: str,
+                            report_name_prefix: str = "") -> None:
+    """
+    Set Compute Engine usage export bucket for the Cloud Project.
+    This sample presents how to interpret default value for the name prefix
+    parameter.
+
+    Params:
+        project_id: project ID or project number of the project to update.
+        bucket_name: Google Cloud Storage Bucket used to store Compute Engine
+            usage reports. An existing Google Cloud Storage bucket is required.
+        report_name_prefix: Report Name Prefix which defaults to an empty string
+            to showcase default values behaviour.
+    """
+    usage_export_location = compute_v1.UsageExportLocation({
+        'bucket_name': bucket_name,
+        'report_name_prefix': report_name_prefix
+    })
+
+    if not report_name_prefix:
+        # Sending empty value for report_name_prefix, will result with the
+        # next usage report generated will have the default prefix value
+        # "usage_gce". (ref: https://cloud.google.com/compute/docs/reference/rest/v1/projects/get)
+        print("Setting report_name_prefix to empty value will cause the report "
+              "to have the default prefix of `usage_gce`.")
+
+    projects_client = compute_v1.ProjectsClient()
+    projects_client.set_usage_export_bucket(
+        project=project_id, usage_export_location_resource=usage_export_location)
+    return
+# [END compute_usage_report_set]
+
+
+# [START compute_usage_report_get]
+def get_usage_export_bucket(project_id: str) -> compute_v1.UsageExportLocation:
+    """
+    Retrieve Compute Engine usage export bucket for the Cloud Project.
+    Replaces the empty value returned by the API with the default value used
+    to generate report file names.
+
+    Params:
+        project_id: project ID or project number of the project to update.
+    Returns:
+        UsageExportLocation object describing the current usage export settings
+        for project project_id.
+    """
+    projects_client = compute_v1.ProjectsClient()
+    project_data = projects_client.get(project=project_id)
+
+    uel = project_data.usage_export_location
+
+    if not uel.bucket_name:
+        # The Usage Reports are disabled.
+        return uel
+    if not uel.report_name_prefix:
+        # Although the server sent the empty value, the next usage report
+        # generated with these settings still has the default prefix value
+        # "usage_gce". (ref: https://cloud.google.com/compute/docs/reference/rest/v1/projects/get)
+        print('Report name prefix not set, replacing with default value of '
+              '`usage_gce`.')
+        uel.report_name_prefix = 'usage_gce'
+    return uel
+# [END compute_usage_report_get]
+# [END compute_instances_verify_default_value]
+
+
+# [START compute_usage_report_disable]
+def disable_usage_export(project_id: str) -> None:
+    """
+    Disable Compute Engine usage export bucket for the Cloud Project.
+
+    Params:
+        project_id: project ID or project number of the project to update.
+    """
+    projects_client = compute_v1.ProjectsClient()
+    export_location = compute_v1.UsageExportLocation(
+        {'bucket_name': '', 'report_name_prefix': ''})
+
+    # Updating the setting with empty bucket name will disable the
+    # usage report generation.
+    projects_client.set_usage_export_bucket(
+        project=project_id, usage_export_location_resource=export_location)
+    return
+# [END compute_usage_report_disable]