File: //lib/mysqlsh/lib/python3.8/site-packages/oci/core/models/create_volume_group_backup_details.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20160918
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class CreateVolumeGroupBackupDetails(object):
"""
CreateVolumeGroupBackupDetails model.
"""
#: A constant which can be used with the type property of a CreateVolumeGroupBackupDetails.
#: This constant has a value of "FULL"
TYPE_FULL = "FULL"
#: A constant which can be used with the type property of a CreateVolumeGroupBackupDetails.
#: This constant has a value of "INCREMENTAL"
TYPE_INCREMENTAL = "INCREMENTAL"
def __init__(self, **kwargs):
"""
Initializes a new CreateVolumeGroupBackupDetails object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param compartment_id:
The value to assign to the compartment_id property of this CreateVolumeGroupBackupDetails.
:type compartment_id: str
:param defined_tags:
The value to assign to the defined_tags property of this CreateVolumeGroupBackupDetails.
:type defined_tags: dict(str, dict(str, object))
:param display_name:
The value to assign to the display_name property of this CreateVolumeGroupBackupDetails.
:type display_name: str
:param freeform_tags:
The value to assign to the freeform_tags property of this CreateVolumeGroupBackupDetails.
:type freeform_tags: dict(str, str)
:param type:
The value to assign to the type property of this CreateVolumeGroupBackupDetails.
Allowed values for this property are: "FULL", "INCREMENTAL"
:type type: str
:param volume_group_id:
The value to assign to the volume_group_id property of this CreateVolumeGroupBackupDetails.
:type volume_group_id: str
"""
self.swagger_types = {
'compartment_id': 'str',
'defined_tags': 'dict(str, dict(str, object))',
'display_name': 'str',
'freeform_tags': 'dict(str, str)',
'type': 'str',
'volume_group_id': 'str'
}
self.attribute_map = {
'compartment_id': 'compartmentId',
'defined_tags': 'definedTags',
'display_name': 'displayName',
'freeform_tags': 'freeformTags',
'type': 'type',
'volume_group_id': 'volumeGroupId'
}
self._compartment_id = None
self._defined_tags = None
self._display_name = None
self._freeform_tags = None
self._type = None
self._volume_group_id = None
@property
def compartment_id(self):
"""
Gets the compartment_id of this CreateVolumeGroupBackupDetails.
The OCID of the compartment that will contain the volume group
backup. This parameter is optional, by default backup will be created in
the same compartment and source volume group.
:return: The compartment_id of this CreateVolumeGroupBackupDetails.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this CreateVolumeGroupBackupDetails.
The OCID of the compartment that will contain the volume group
backup. This parameter is optional, by default backup will be created in
the same compartment and source volume group.
:param compartment_id: The compartment_id of this CreateVolumeGroupBackupDetails.
:type: str
"""
self._compartment_id = compartment_id
@property
def defined_tags(self):
"""
Gets the defined_tags of this CreateVolumeGroupBackupDetails.
Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this CreateVolumeGroupBackupDetails.
:rtype: dict(str, dict(str, object))
"""
return self._defined_tags
@defined_tags.setter
def defined_tags(self, defined_tags):
"""
Sets the defined_tags of this CreateVolumeGroupBackupDetails.
Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this CreateVolumeGroupBackupDetails.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def display_name(self):
"""
Gets the display_name of this CreateVolumeGroupBackupDetails.
A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
:return: The display_name of this CreateVolumeGroupBackupDetails.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this CreateVolumeGroupBackupDetails.
A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
:param display_name: The display_name of this CreateVolumeGroupBackupDetails.
:type: str
"""
self._display_name = display_name
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this CreateVolumeGroupBackupDetails.
Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see `Resource Tags`__.
Example: `{\"Department\": \"Finance\"}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:return: The freeform_tags of this CreateVolumeGroupBackupDetails.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this CreateVolumeGroupBackupDetails.
Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see `Resource Tags`__.
Example: `{\"Department\": \"Finance\"}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:param freeform_tags: The freeform_tags of this CreateVolumeGroupBackupDetails.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def type(self):
"""
Gets the type of this CreateVolumeGroupBackupDetails.
The type of backup to create. If omitted, defaults to incremental.
Allowed values for this property are: "FULL", "INCREMENTAL"
:return: The type of this CreateVolumeGroupBackupDetails.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this CreateVolumeGroupBackupDetails.
The type of backup to create. If omitted, defaults to incremental.
:param type: The type of this CreateVolumeGroupBackupDetails.
:type: str
"""
allowed_values = ["FULL", "INCREMENTAL"]
if not value_allowed_none_or_none_sentinel(type, allowed_values):
raise ValueError(
f"Invalid value for `type`, must be None or one of {allowed_values}"
)
self._type = type
@property
def volume_group_id(self):
"""
**[Required]** Gets the volume_group_id of this CreateVolumeGroupBackupDetails.
The OCID of the volume group that needs to be backed up.
:return: The volume_group_id of this CreateVolumeGroupBackupDetails.
:rtype: str
"""
return self._volume_group_id
@volume_group_id.setter
def volume_group_id(self, volume_group_id):
"""
Sets the volume_group_id of this CreateVolumeGroupBackupDetails.
The OCID of the volume group that needs to be backed up.
:param volume_group_id: The volume_group_id of this CreateVolumeGroupBackupDetails.
:type: str
"""
self._volume_group_id = volume_group_id
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other