feat: Created Snapshot Schedule Samples -> Get, Create, Delete, List operations (#13012)

* Created Get, Create, Delete, List samples

* Created Schedule attach disk sample

* Created Schedule detach disk sample

* Created an Update a snapshot schedule Sample

* Added some delays

Author: Thoughtseize1

compute/client_library/ingredients/snapshots/schedule_attach_disk.py

@@ -0,0 +1,52 @@
+#  Copyright 2024 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.
+
+# This is an ingredient file. It is not meant to be run directly. Check the samples/snippets
+# folder for complete code samples that are ready to be used.
+# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
+# flake8: noqa
+
+from google.cloud import compute_v1
+
+
+# <INGREDIENT attach_disk_schedule_snapshots>
+def snapshot_schedule_attach(
+    project_id: str, zone: str, region: str, disk_name: str, schedule_name: str
+) -> None:
+    """
+    Attaches a snapshot schedule to a specified disk.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        zone (str): The zone where the disk is located.
+        region (str): The region where the snapshot schedule was created
+        disk_name (str): The name of the disk to which the snapshot schedule will be attached.
+        schedule_name (str): The name of the snapshot schedule that you are applying to this disk
+    Returns:
+        None
+    """
+    disks_add_request = compute_v1.DisksAddResourcePoliciesRequest(
+        resource_policies=[f"regions/{region}/resourcePolicies/{schedule_name}"]
+    )
+
+    client = compute_v1.DisksClient()
+    operation = client.add_resource_policies(
+        project=project_id,
+        zone=zone,
+        disk=disk_name,
+        disks_add_resource_policies_request_resource=disks_add_request,
+    )
+    wait_for_extended_operation(operation, "Attaching snapshot schedule to disk")
+
+
+# </INGREDIENT>

compute/client_library/ingredients/snapshots/schedule_create.py

@@ -0,0 +1,95 @@
+#  Copyright 2024 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.
+
+# This is an ingredient file. It is not meant to be run directly. Check the samples/snippets
+# folder for complete code samples that are ready to be used.
+# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
+# flake8: noqa
+
+from google.cloud import compute_v1
+
+
+# <INGREDIENT create_schedule_snapshots>
+def snapshot_schedule_create(
+    project_id: str,
+    region: str,
+    schedule_name: str,
+    schedule_description: str,
+    labels: dict,
+) -> compute_v1.ResourcePolicy:
+    """
+    Creates a snapshot schedule for disks for a specified project and region.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        region (str): The region where the snapshot schedule will be created.
+        schedule_name (str): The name of the snapshot schedule group.
+        schedule_description (str): The description of the snapshot schedule group.
+        labels (dict): The labels to apply to the snapshots. Example: {"env": "dev", "media": "images"}
+    Returns:
+        compute_v1.ResourcePolicy: The created resource policy.
+    """
+
+    # # Every hour, starts at 12:00 AM
+    # hourly_schedule = compute_v1.ResourcePolicyHourlyCycle(
+    #     hours_in_cycle=1, start_time="00:00"
+    # )
+    #
+    # # Every Monday, starts between 12:00 AM and 1:00 AM
+    # day = compute_v1.ResourcePolicyWeeklyCycleDayOfWeek(
+    #     day="MONDAY", start_time="00:00"
+    # )
+    # weekly_schedule = compute_v1.ResourcePolicyWeeklyCycle(day_of_weeks=[day])
+
+    # In this example we use daily_schedule - every day, starts between 12:00 AM and 1:00 AM
+    daily_schedule = compute_v1.ResourcePolicyDailyCycle(
+        days_in_cycle=1, start_time="00:00"
+    )
+
+    schedule = compute_v1.ResourcePolicySnapshotSchedulePolicySchedule()
+    # You can change the schedule type to daily_schedule, weekly_schedule, or hourly_schedule
+    schedule.daily_schedule = daily_schedule
+
+    # Autodelete snapshots after 5 days
+    retention_policy = compute_v1.ResourcePolicySnapshotSchedulePolicyRetentionPolicy(
+        max_retention_days=5
+    )
+    snapshot_properties = (
+        compute_v1.ResourcePolicySnapshotSchedulePolicySnapshotProperties(
+            guest_flush=False, labels=labels
+        )
+    )
+
+    snapshot_policy = compute_v1.ResourcePolicySnapshotSchedulePolicy()
+    snapshot_policy.schedule = schedule
+    snapshot_policy.retention_policy = retention_policy
+    snapshot_policy.snapshot_properties = snapshot_properties
+
+    resource_policy_resource = compute_v1.ResourcePolicy(
+        name=schedule_name,
+        description=schedule_description,
+        snapshot_schedule_policy=snapshot_policy,
+    )
+
+    client = compute_v1.ResourcePoliciesClient()
+    operation = client.insert(
+        project=project_id,
+        region=region,
+        resource_policy_resource=resource_policy_resource,
+    )
+    wait_for_extended_operation(operation, "Resource Policy creation")
+
+    return client.get(project=project_id, region=region, resource_policy=schedule_name)
+
+
+# </INGREDIENT>

compute/client_library/ingredients/snapshots/schedule_delete.py

@@ -0,0 +1,43 @@
+#  Copyright 2024 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.
+
+# This is an ingredient file. It is not meant to be run directly. Check the samples/snippets
+# folder for complete code samples that are ready to be used.
+# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
+# flake8: noqa
+
+from google.cloud import compute_v1
+
+
+# <INGREDIENT delete_schedule_snapshots>
+def snapshot_schedule_delete(
+    project_id: str, region: str, snapshot_schedule_name: str
+) -> None:
+    """
+    Deletes a snapshot schedule for a specified project and region.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        region (str): The region where the snapshot schedule is located.
+        snapshot_schedule_name (str): The name of the snapshot schedule to delete.
+    Returns:
+        None
+    """
+    client = compute_v1.ResourcePoliciesClient()
+    operation = client.delete(
+        project=project_id, region=region, resource_policy=snapshot_schedule_name
+    )
+    wait_for_extended_operation(operation, "Resource Policy deletion")
+
+
+# </INGREDIENT>

compute/client_library/ingredients/snapshots/schedule_get.py

@@ -0,0 +1,43 @@
+#  Copyright 2024 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.
+
+# This is an ingredient file. It is not meant to be run directly. Check the samples/snippets
+# folder for complete code samples that are ready to be used.
+# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
+# flake8: noqa
+
+from google.cloud import compute_v1
+
+
+# <INGREDIENT get_schedule_snapshots>
+def snapshot_schedule_get(
+    project_id: str, region: str, snapshot_schedule_name: str
+) -> compute_v1.ResourcePolicy:
+    """
+    Retrieves a snapshot schedule for a specified project and region.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        region (str): The region where the snapshot schedule is located.
+        snapshot_schedule_name (str): The name of the snapshot schedule.
+    Returns:
+        compute_v1.ResourcePolicy: The retrieved snapshot schedule.
+    """
+    client = compute_v1.ResourcePoliciesClient()
+    schedule = client.get(
+        project=project_id, region=region, resource_policy=snapshot_schedule_name
+    )
+    return schedule
+
+
+# </INGREDIENT>

compute/client_library/ingredients/snapshots/schedule_list.py

@@ -0,0 +1,46 @@
+#  Copyright 2024 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.
+
+# This is an ingredient file. It is not meant to be run directly. Check the samples/snippets
+# folder for complete code samples that are ready to be used.
+# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
+# flake8: noqa
+
+from google.cloud import compute_v1
+from google.cloud.compute_v1.services.resource_policies import pagers
+
+
+# <INGREDIENT list_schedule_snapshots>
+def snapshot_schedule_list(project_id: str, region: str) -> pagers.ListPager:
+    """
+    Lists snapshot schedules for a specified project and region.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        region (str): The region where the snapshot schedules are located.
+    Returns:
+        ListPager: A pager for iterating through the list of snapshot schedules.
+    """
+    client = compute_v1.ResourcePoliciesClient()
+
+    request = compute_v1.ListResourcePoliciesRequest(
+        project=project_id,
+        region=region,
+        filter='status = "READY"',  # Optional filter
+    )
+
+    schedules = client.list(request=request)
+    return schedules
+
+
+# </INGREDIENT>

compute/client_library/ingredients/snapshots/schedule_remove_disk.py

@@ -0,0 +1,52 @@
+#  Copyright 2024 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.
+
+# This is an ingredient file. It is not meant to be run directly. Check the samples/snippets
+# folder for complete code samples that are ready to be used.
+# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
+# flake8: noqa
+
+from google.cloud import compute_v1
+
+
+# <INGREDIENT remove_disk_schedule_snapshots>
+def snapshot_schedule_detach_disk(
+    project_id: str, zone: str, region: str, disk_name: str, schedule_name: str
+) -> None:
+    """
+    Detaches a snapshot schedule from a specified disk in a given project and zone.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        zone (str): The zone where the disk is located.
+        region (str): The location of the snapshot schedule
+        disk_name (str): The name of the disk with the associated snapshot schedule
+        schedule_name (str): The name of the snapshot schedule that you are removing from this disk
+    Returns:
+        None
+    """
+    disks_remove_request = compute_v1.DisksRemoveResourcePoliciesRequest(
+        resource_policies=[f"regions/{region}/resourcePolicies/{schedule_name}"]
+    )
+
+    client = compute_v1.DisksClient()
+    operation = client.remove_resource_policies(
+        project=project_id,
+        zone=zone,
+        disk=disk_name,
+        disks_remove_resource_policies_request_resource=disks_remove_request,
+    )
+    wait_for_extended_operation(operation, "Detaching snapshot schedule from disk")
+
+
+# </INGREDIENT>