feat: [google-cloud-gke-backup] Add BackupChannel field in BackupPlan (#13905)

BEGIN_COMMIT_OVERRIDE feat: Add BackupChannel field in BackupPlan feat: Add RestoreChannel field in RestorePlan feat: Add BackupConfig of Backups in BackupPlanBinding feat: Add support for Project ID in BackupChannel and RestoreChannel docs: minor documentation fixes END_COMMIT_OVERRIDE - [ ] Regenerate this pull request now. feat: Add RestoreChannel field in RestorePlan feat: Add BackupConfig of Backups in BackupPlanBinding feat: Add support for Project ID in BackupChannel and RestoreChannel docs: minor documentation fixes PiperOrigin-RevId: 758503180 Source-Link: googleapis/googleapis@8a3ddf0 Source-Link: googleapis/googleapis-gen@9c42164 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWdrZS1iYWNrdXAvLk93bEJvdC55YW1sIiwiaCI6IjljNDIxNjQ0YjNkMTUzM2UxODUzY2RhZTliNTI5NjNlNmNhZjgzZjYifQ== --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: gcf-owl-bot[bot]

packages/google-cloud-gke-backup/google/cloud/gke_backup_v1/types/backup_channel.py

@@ -40,9 +40,8 @@ class BackupChannel(proto.Message):
  ``projects/*/locations/*/backupChannels/*``
  destination_project (str):
  Required. Immutable. The project where Backups are allowed
- to be stored. The format is ``projects/{project}``.
- Currently, {project} can only be the project number. Support
- for project IDs will be added in the future.
+ to be stored. The format is ``projects/{projectId}`` or
+ ``projects/{projectNumber}``.
  uid (str):
  Output only. Server generated global unique identifier of
  `UUID <https://en.wikipedia.org/wiki/Universally_unique_identifier>`__

packages/google-cloud-gke-backup/google/cloud/gke_backup_v1/types/backup_plan.py

@@ -121,6 +121,11 @@ class BackupPlan(proto.Message):
  Output only. Human-readable description of why the
  BackupPlan is in the current rpo_risk_level and action items
  if any.
+ backup_channel (str):
+ Output only. The fully qualified name of the BackupChannel
+ to be used to create a backup. This field is set only if the
+ cluster being backed up is in a different project.
+ ``projects/*/locations/*/backupChannels/*``
  last_successful_backup_time (google.protobuf.timestamp_pb2.Timestamp):
  Output only. Completion time of the last successful Backup.
  This is sourced from a successful Backup's complete_time
@@ -439,6 +444,10 @@ class BackupConfig(proto.Message):
  proto.STRING,
  number=17,
  )
+ backup_channel: str = proto.Field(
+ proto.STRING,
+ number=18,
+ )
  last_successful_backup_time: timestamp_pb2.Timestamp = proto.Field(
  proto.MESSAGE,
  number=19,

packages/google-cloud-gke-backup/google/cloud/gke_backup_v1/types/backup_plan_binding.py

@@ -20,6 +20,8 @@
 from google.protobuf import timestamp_pb2 # type: ignore
 import proto # type: ignore
 
+from google.cloud.gke_backup_v1.types import common
+
 __protobuf__ = proto.module(
  package="google.cloud.gkebackup.v1",
  manifest={
@@ -103,6 +105,14 @@ class BackupPlanDetails(proto.Message):
  Output only. The fully qualified name of the last successful
  Backup created under this BackupPlan.
  ``projects/*/locations/*/backupPlans/*/backups/*``
+ backup_config_details (google.cloud.gke_backup_v1.types.BackupPlanBinding.BackupPlanDetails.BackupConfigDetails):
+ Output only. Contains details about the
+ BackupConfig of Backups created via this
+ BackupPlan.
+ retention_policy_details (google.cloud.gke_backup_v1.types.BackupPlanBinding.BackupPlanDetails.RetentionPolicyDetails):
+ Output only. Contains details about the
+ RetentionPolicy of Backups created via this
+ BackupPlan.
  """
 
  class State(proto.Enum):
@@ -135,6 +145,123 @@ class State(proto.Enum):
  DEACTIVATED = 5
  DELETING = 6
 
+ class BackupConfigDetails(proto.Message):
+ r"""BackupConfigDetails defines the configuration of Backups
+ created via this BackupPlan.
+
+ This message has `oneof`_ fields (mutually exclusive fields).
+ For each oneof, at most one member field can be set at the same time.
+ Setting any member of the oneof automatically clears all other
+ members.
+
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+ Attributes:
+ all_namespaces (bool):
+ Output only. If True, include all namespaced
+ resources
+
+ This field is a member of `oneof`_ ``backup_scope``.
+ selected_namespaces (google.cloud.gke_backup_v1.types.Namespaces):
+ Output only. If set, include just the
+ resources in the listed namespaces.
+
+ This field is a member of `oneof`_ ``backup_scope``.
+ selected_applications (google.cloud.gke_backup_v1.types.NamespacedNames):
+ Output only. If set, include just the
+ resources referenced by the listed
+ ProtectedApplications.
+
+ This field is a member of `oneof`_ ``backup_scope``.
+ include_volume_data (bool):
+ Output only. This flag specifies whether
+ volume data should be backed up when PVCs are
+ included in the scope of a Backup.
+
+ Default: False
+ include_secrets (bool):
+ Output only. This flag specifies whether
+ Kubernetes Secret resources should be included
+ when they fall into the scope of Backups.
+
+ Default: False
+ encryption_key (google.cloud.gke_backup_v1.types.EncryptionKey):
+ Output only. This defines a customer managed
+ encryption key that will be used to encrypt the
+ "config" portion (the Kubernetes resources) of
+ Backups created via this plan.
+
+ Default (empty): Config backup artifacts will
+ not be encrypted.
+ """
+
+ all_namespaces: bool = proto.Field(
+ proto.BOOL,
+ number=1,
+ oneof="backup_scope",
+ )
+ selected_namespaces: common.Namespaces = proto.Field(
+ proto.MESSAGE,
+ number=2,
+ oneof="backup_scope",
+ message=common.Namespaces,
+ )
+ selected_applications: common.NamespacedNames = proto.Field(
+ proto.MESSAGE,
+ number=3,
+ oneof="backup_scope",
+ message=common.NamespacedNames,
+ )
+ include_volume_data: bool = proto.Field(
+ proto.BOOL,
+ number=5,
+ )
+ include_secrets: bool = proto.Field(
+ proto.BOOL,
+ number=6,
+ )
+ encryption_key: common.EncryptionKey = proto.Field(
+ proto.MESSAGE,
+ number=7,
+ message=common.EncryptionKey,
+ )
+
+ class RetentionPolicyDetails(proto.Message):
+ r"""RetentionPolicyDetails defines a Backup retention policy for
+ a BackupPlan.
+
+ Attributes:
+ backup_delete_lock_days (int):
+ Optional. Minimum age for Backups created via this
+ BackupPlan (in days). This field MUST be an integer value
+ between 0-90 (inclusive). A Backup created under this
+ BackupPlan will NOT be deletable until it reaches Backup's
+ (create_time + backup_delete_lock_days). Updating this field
+ of a BackupPlan does NOT affect existing Backups under it.
+ Backups created AFTER a successful update will inherit the
+ new value.
+
+ Default: 0 (no delete blocking)
+ backup_retain_days (int):
+ Optional. The default maximum age of a Backup created via
+ this BackupPlan. This field MUST be an integer value >= 0
+ and <= 365. If specified, a Backup created under this
+ BackupPlan will be automatically deleted after its age
+ reaches (create_time + backup_retain_days). If not
+ specified, Backups created under this BackupPlan will NOT be
+ subject to automatic deletion. Default: 0 (no automatic
+ deletion)
+ """
+
+ backup_delete_lock_days: int = proto.Field(
+ proto.INT32,
+ number=1,
+ )
+ backup_retain_days: int = proto.Field(
+ proto.INT32,
+ number=2,
+ )
+
  protected_pod_count: int = proto.Field(
  proto.INT32,
  number=1,
@@ -162,6 +289,16 @@ class State(proto.Enum):
  proto.STRING,
  number=6,
  )
+ backup_config_details: "BackupPlanBinding.BackupPlanDetails.BackupConfigDetails" = proto.Field(
+ proto.MESSAGE,
+ number=7,
+ message="BackupPlanBinding.BackupPlanDetails.BackupConfigDetails",
+ )
+ retention_policy_details: "BackupPlanBinding.BackupPlanDetails.RetentionPolicyDetails" = proto.Field(
+ proto.MESSAGE,
+ number=8,
+ message="BackupPlanBinding.BackupPlanDetails.RetentionPolicyDetails",
+ )
 
  name: str = proto.Field(
  proto.STRING,

packages/google-cloud-gke-backup/google/cloud/gke_backup_v1/types/restore_channel.py

@@ -40,9 +40,8 @@ class RestoreChannel(proto.Message):
  ``projects/*/locations/*/restoreChannels/*``
  destination_project (str):
  Required. Immutable. The project into which the backups will
- be restored. The format is ``projects/{project}``.
- Currently, {project} can only be the project number. Support
- for project IDs will be added in the future.
+ be restored. The format is ``projects/{projectId}`` or
+ ``projects/{projectNumber}``.
  uid (str):
  Output only. Server generated global unique identifier of
  `UUID <https://en.wikipedia.org/wiki/Universally_unique_identifier>`__

packages/google-cloud-gke-backup/google/cloud/gke_backup_v1/types/restore_plan.py

@@ -93,6 +93,12 @@ class RestorePlan(proto.Message):
  is in the current ``state``. This field is only meant for
  human readability and should not be used programmatically as
  this field is not guaranteed to be consistent.
+ restore_channel (str):
+ Output only. The fully qualified name of the RestoreChannel
+ to be used to create a RestorePlan. This field is set only
+ if the ``backup_plan`` is in a different project than the
+ RestorePlan. Format:
+ ``projects/*/locations/*/restoreChannels/*``
  """
 
  class State(proto.Enum):
@@ -171,6 +177,10 @@ class State(proto.Enum):
  proto.STRING,
  number=12,
  )
+ restore_channel: str = proto.Field(
+ proto.STRING,
+ number=13,
+ )
 
 
 __all__ = tuple(sorted(__protobuf__.manifest))

packages/google-cloud-gke-backup/tests/unit/gapic/gke_backup_v1/test_backup_for_gke.py

@@ -2071,6 +2071,7 @@ def test_get_backup_plan(request_type, transport: str = "grpc"):
  state_reason="state_reason_value",
  rpo_risk_level=1504,
  rpo_risk_reason="rpo_risk_reason_value",
+ backup_channel="backup_channel_value",
  )
  response = client.get_backup_plan(request)
 
@@ -2093,6 +2094,7 @@ def test_get_backup_plan(request_type, transport: str = "grpc"):
  assert response.state_reason == "state_reason_value"
  assert response.rpo_risk_level == 1504
  assert response.rpo_risk_reason == "rpo_risk_reason_value"
+ assert response.backup_channel == "backup_channel_value"
 
 
 def test_get_backup_plan_non_empty_request_with_auto_populated_field():
@@ -2229,6 +2231,7 @@ async def test_get_backup_plan_async(
  state_reason="state_reason_value",
  rpo_risk_level=1504,
  rpo_risk_reason="rpo_risk_reason_value",
+ backup_channel="backup_channel_value",
  )
  )
  response = await client.get_backup_plan(request)
@@ -2252,6 +2255,7 @@ async def test_get_backup_plan_async(
  assert response.state_reason == "state_reason_value"
  assert response.rpo_risk_level == 1504
  assert response.rpo_risk_reason == "rpo_risk_reason_value"
+ assert response.backup_channel == "backup_channel_value"
 
 
 @pytest.mark.asyncio
@@ -9806,6 +9810,7 @@ def test_get_restore_plan(request_type, transport: str = "grpc"):
  etag="etag_value",
  state=restore_plan.RestorePlan.State.CLUSTER_PENDING,
  state_reason="state_reason_value",
+ restore_channel="restore_channel_value",
  )
  response = client.get_restore_plan(request)
 
@@ -9825,6 +9830,7 @@ def test_get_restore_plan(request_type, transport: str = "grpc"):
  assert response.etag == "etag_value"
  assert response.state == restore_plan.RestorePlan.State.CLUSTER_PENDING
  assert response.state_reason == "state_reason_value"
+ assert response.restore_channel == "restore_channel_value"
 
 
 def test_get_restore_plan_non_empty_request_with_auto_populated_field():
@@ -9960,6 +9966,7 @@ async def test_get_restore_plan_async(
  etag="etag_value",
  state=restore_plan.RestorePlan.State.CLUSTER_PENDING,
  state_reason="state_reason_value",
+ restore_channel="restore_channel_value",
  )
  )
  response = await client.get_restore_plan(request)
@@ -9980,6 +9987,7 @@ async def test_get_restore_plan_async(
  assert response.etag == "etag_value"
  assert response.state == restore_plan.RestorePlan.State.CLUSTER_PENDING
  assert response.state_reason == "state_reason_value"
+ assert response.restore_channel == "restore_channel_value"
 
 
 @pytest.mark.asyncio
@@ -26091,6 +26099,7 @@ async def test_get_backup_plan_empty_call_grpc_asyncio():
  state_reason="state_reason_value",
  rpo_risk_level=1504,
  rpo_risk_reason="rpo_risk_reason_value",
+ backup_channel="backup_channel_value",
  )
  )
  await client.get_backup_plan(request=None)
@@ -26660,6 +26669,7 @@ async def test_get_restore_plan_empty_call_grpc_asyncio():
  etag="etag_value",
  state=restore_plan.RestorePlan.State.CLUSTER_PENDING,
  state_reason="state_reason_value",
+ restore_channel="restore_channel_value",
  )
  )
  await client.get_restore_plan(request=None)
@@ -27278,6 +27288,7 @@ def test_create_backup_plan_rest_call_success(request_type):
  "state_reason": "state_reason_value",
  "rpo_risk_level": 1504,
  "rpo_risk_reason": "rpo_risk_reason_value",
+ "backup_channel": "backup_channel_value",
  "last_successful_backup_time": {},
  }
  # The version of a generated dependency at test runtime may differ from the version used during generation.
@@ -27616,6 +27627,7 @@ def test_get_backup_plan_rest_call_success(request_type):
  state_reason="state_reason_value",
  rpo_risk_level=1504,
  rpo_risk_reason="rpo_risk_reason_value",
+ backup_channel="backup_channel_value",
  )
 
  # Wrap the value into a proper Response obj
@@ -27643,6 +27655,7 @@ def test_get_backup_plan_rest_call_success(request_type):
  assert response.state_reason == "state_reason_value"
  assert response.rpo_risk_level == 1504
  assert response.rpo_risk_reason == "rpo_risk_reason_value"
+ assert response.backup_channel == "backup_channel_value"
 
 
 @pytest.mark.parametrize("null_interceptor", [True, False])
@@ -27815,6 +27828,7 @@ def test_update_backup_plan_rest_call_success(request_type):
  "state_reason": "state_reason_value",
  "rpo_risk_level": 1504,
  "rpo_risk_reason": "rpo_risk_reason_value",
+ "backup_channel": "backup_channel_value",
  "last_successful_backup_time": {},
  }
  # The version of a generated dependency at test runtime may differ from the version used during generation.
@@ -30464,6 +30478,7 @@ def test_create_restore_plan_rest_call_success(request_type):
  "etag": "etag_value",
  "state": 1,
  "state_reason": "state_reason_value",
+ "restore_channel": "restore_channel_value",
  }
  # The version of a generated dependency at test runtime may differ from the version used during generation.
  # Delete any fields which are not present in the current runtime dependency
@@ -30800,6 +30815,7 @@ def test_get_restore_plan_rest_call_success(request_type):
  etag="etag_value",
  state=restore_plan.RestorePlan.State.CLUSTER_PENDING,
  state_reason="state_reason_value",
+ restore_channel="restore_channel_value",
  )
 
  # Wrap the value into a proper Response obj
@@ -30824,6 +30840,7 @@ def test_get_restore_plan_rest_call_success(request_type):
  assert response.etag == "etag_value"
  assert response.state == restore_plan.RestorePlan.State.CLUSTER_PENDING
  assert response.state_reason == "state_reason_value"
+ assert response.restore_channel == "restore_channel_value"
 
 
 @pytest.mark.parametrize("null_interceptor", [True, False])
@@ -31008,6 +31025,7 @@ def test_update_restore_plan_rest_call_success(request_type):
  "etag": "etag_value",
  "state": 1,
  "state_reason": "state_reason_value",
+ "restore_channel": "restore_channel_value",
  }
  # The version of a generated dependency at test runtime may differ from the version used during generation.
  # Delete any fields which are not present in the current runtime dependency