File: //lib/mysqlsh/lib/python3.8/site-packages/oci/fleet_apps_management/models/onboarding.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: 20250228
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 Onboarding(object):
"""
Fleet Application Management onboarding resource.
The onboarding process lets\u00A0Fleet Application Management\u00A0create a few required policies that you need to start using it and its features.
"""
#: A constant which can be used with the lifecycle_state property of a Onboarding.
#: This constant has a value of "ACTIVE"
LIFECYCLE_STATE_ACTIVE = "ACTIVE"
#: A constant which can be used with the lifecycle_state property of a Onboarding.
#: This constant has a value of "INACTIVE"
LIFECYCLE_STATE_INACTIVE = "INACTIVE"
#: A constant which can be used with the lifecycle_state property of a Onboarding.
#: This constant has a value of "CREATING"
LIFECYCLE_STATE_CREATING = "CREATING"
#: A constant which can be used with the lifecycle_state property of a Onboarding.
#: This constant has a value of "DELETED"
LIFECYCLE_STATE_DELETED = "DELETED"
#: A constant which can be used with the lifecycle_state property of a Onboarding.
#: This constant has a value of "DELETING"
LIFECYCLE_STATE_DELETING = "DELETING"
#: A constant which can be used with the lifecycle_state property of a Onboarding.
#: This constant has a value of "FAILED"
LIFECYCLE_STATE_FAILED = "FAILED"
#: A constant which can be used with the lifecycle_state property of a Onboarding.
#: This constant has a value of "UPDATING"
LIFECYCLE_STATE_UPDATING = "UPDATING"
#: A constant which can be used with the lifecycle_state property of a Onboarding.
#: This constant has a value of "NEEDS_ATTENTION"
LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION"
def __init__(self, **kwargs):
"""
Initializes a new Onboarding object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param id:
The value to assign to the id property of this Onboarding.
:type id: str
:param compartment_id:
The value to assign to the compartment_id property of this Onboarding.
:type compartment_id: str
:param resource_region:
The value to assign to the resource_region property of this Onboarding.
:type resource_region: str
:param time_created:
The value to assign to the time_created property of this Onboarding.
:type time_created: datetime
:param time_updated:
The value to assign to the time_updated property of this Onboarding.
:type time_updated: datetime
:param is_fams_tag_enabled:
The value to assign to the is_fams_tag_enabled property of this Onboarding.
:type is_fams_tag_enabled: bool
:param version:
The value to assign to the version property of this Onboarding.
:type version: str
:param is_cost_tracking_tag_enabled:
The value to assign to the is_cost_tracking_tag_enabled property of this Onboarding.
:type is_cost_tracking_tag_enabled: bool
:param applied_policies:
The value to assign to the applied_policies property of this Onboarding.
:type applied_policies: oci.fleet_apps_management.models.OnboardingPolicySummary
:param discovery_frequency:
The value to assign to the discovery_frequency property of this Onboarding.
:type discovery_frequency: str
:param lifecycle_state:
The value to assign to the lifecycle_state property of this Onboarding.
Allowed values for this property are: "ACTIVE", "INACTIVE", "CREATING", "DELETED", "DELETING", "FAILED", "UPDATING", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type lifecycle_state: str
:param system_tags:
The value to assign to the system_tags property of this Onboarding.
:type system_tags: dict(str, dict(str, object))
:param freeform_tags:
The value to assign to the freeform_tags property of this Onboarding.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this Onboarding.
:type defined_tags: dict(str, dict(str, object))
"""
self.swagger_types = {
'id': 'str',
'compartment_id': 'str',
'resource_region': 'str',
'time_created': 'datetime',
'time_updated': 'datetime',
'is_fams_tag_enabled': 'bool',
'version': 'str',
'is_cost_tracking_tag_enabled': 'bool',
'applied_policies': 'OnboardingPolicySummary',
'discovery_frequency': 'str',
'lifecycle_state': 'str',
'system_tags': 'dict(str, dict(str, object))',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))'
}
self.attribute_map = {
'id': 'id',
'compartment_id': 'compartmentId',
'resource_region': 'resourceRegion',
'time_created': 'timeCreated',
'time_updated': 'timeUpdated',
'is_fams_tag_enabled': 'isFamsTagEnabled',
'version': 'version',
'is_cost_tracking_tag_enabled': 'isCostTrackingTagEnabled',
'applied_policies': 'appliedPolicies',
'discovery_frequency': 'discoveryFrequency',
'lifecycle_state': 'lifecycleState',
'system_tags': 'systemTags',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags'
}
self._id = None
self._compartment_id = None
self._resource_region = None
self._time_created = None
self._time_updated = None
self._is_fams_tag_enabled = None
self._version = None
self._is_cost_tracking_tag_enabled = None
self._applied_policies = None
self._discovery_frequency = None
self._lifecycle_state = None
self._system_tags = None
self._freeform_tags = None
self._defined_tags = None
@property
def id(self):
"""
**[Required]** Gets the id of this Onboarding.
The unique id of the resource.
:return: The id of this Onboarding.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this Onboarding.
The unique id of the resource.
:param id: The id of this Onboarding.
:type: str
"""
self._id = id
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this Onboarding.
Tenancy OCID
:return: The compartment_id of this Onboarding.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this Onboarding.
Tenancy OCID
:param compartment_id: The compartment_id of this Onboarding.
:type: str
"""
self._compartment_id = compartment_id
@property
def resource_region(self):
"""
Gets the resource_region of this Onboarding.
Associated region
:return: The resource_region of this Onboarding.
:rtype: str
"""
return self._resource_region
@resource_region.setter
def resource_region(self, resource_region):
"""
Sets the resource_region of this Onboarding.
Associated region
:param resource_region: The resource_region of this Onboarding.
:type: str
"""
self._resource_region = resource_region
@property
def time_created(self):
"""
Gets the time_created of this Onboarding.
The time this resource was created. An RFC3339 formatted datetime string.
:return: The time_created of this Onboarding.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this Onboarding.
The time this resource was created. An RFC3339 formatted datetime string.
:param time_created: The time_created of this Onboarding.
:type: datetime
"""
self._time_created = time_created
@property
def time_updated(self):
"""
Gets the time_updated of this Onboarding.
The time this resource was last updated. An RFC3339 formatted datetime string.
:return: The time_updated of this Onboarding.
:rtype: datetime
"""
return self._time_updated
@time_updated.setter
def time_updated(self, time_updated):
"""
Sets the time_updated of this Onboarding.
The time this resource was last updated. An RFC3339 formatted datetime string.
:param time_updated: The time_updated of this Onboarding.
:type: datetime
"""
self._time_updated = time_updated
@property
def is_fams_tag_enabled(self):
"""
Gets the is_fams_tag_enabled of this Onboarding.
A value determining if the Fleet Application Management tagging is enabled or not.
Allow Fleet Application Management to tag resources with fleet name using \"Oracle$FAMS-Tags.FleetName\" tag.
:return: The is_fams_tag_enabled of this Onboarding.
:rtype: bool
"""
return self._is_fams_tag_enabled
@is_fams_tag_enabled.setter
def is_fams_tag_enabled(self, is_fams_tag_enabled):
"""
Sets the is_fams_tag_enabled of this Onboarding.
A value determining if the Fleet Application Management tagging is enabled or not.
Allow Fleet Application Management to tag resources with fleet name using \"Oracle$FAMS-Tags.FleetName\" tag.
:param is_fams_tag_enabled: The is_fams_tag_enabled of this Onboarding.
:type: bool
"""
self._is_fams_tag_enabled = is_fams_tag_enabled
@property
def version(self):
"""
Gets the version of this Onboarding.
The version of Fleet Application Management that the tenant is onboarded to.
:return: The version of this Onboarding.
:rtype: str
"""
return self._version
@version.setter
def version(self, version):
"""
Sets the version of this Onboarding.
The version of Fleet Application Management that the tenant is onboarded to.
:param version: The version of this Onboarding.
:type: str
"""
self._version = version
@property
def is_cost_tracking_tag_enabled(self):
"""
Gets the is_cost_tracking_tag_enabled of this Onboarding.
A value determining if the cost tracking tag is enabled or not.
Allow Fleet Application Management to tag resources with cost tracking tag using \"Oracle$FAMS-Tags.FAMSManaged\" tag.
:return: The is_cost_tracking_tag_enabled of this Onboarding.
:rtype: bool
"""
return self._is_cost_tracking_tag_enabled
@is_cost_tracking_tag_enabled.setter
def is_cost_tracking_tag_enabled(self, is_cost_tracking_tag_enabled):
"""
Sets the is_cost_tracking_tag_enabled of this Onboarding.
A value determining if the cost tracking tag is enabled or not.
Allow Fleet Application Management to tag resources with cost tracking tag using \"Oracle$FAMS-Tags.FAMSManaged\" tag.
:param is_cost_tracking_tag_enabled: The is_cost_tracking_tag_enabled of this Onboarding.
:type: bool
"""
self._is_cost_tracking_tag_enabled = is_cost_tracking_tag_enabled
@property
def applied_policies(self):
"""
Gets the applied_policies of this Onboarding.
:return: The applied_policies of this Onboarding.
:rtype: oci.fleet_apps_management.models.OnboardingPolicySummary
"""
return self._applied_policies
@applied_policies.setter
def applied_policies(self, applied_policies):
"""
Sets the applied_policies of this Onboarding.
:param applied_policies: The applied_policies of this Onboarding.
:type: oci.fleet_apps_management.models.OnboardingPolicySummary
"""
self._applied_policies = applied_policies
@property
def discovery_frequency(self):
"""
Gets the discovery_frequency of this Onboarding.
Provide discovery frequency.
:return: The discovery_frequency of this Onboarding.
:rtype: str
"""
return self._discovery_frequency
@discovery_frequency.setter
def discovery_frequency(self, discovery_frequency):
"""
Sets the discovery_frequency of this Onboarding.
Provide discovery frequency.
:param discovery_frequency: The discovery_frequency of this Onboarding.
:type: str
"""
self._discovery_frequency = discovery_frequency
@property
def lifecycle_state(self):
"""
**[Required]** Gets the lifecycle_state of this Onboarding.
The current state of the Onboarding.
Allowed values for this property are: "ACTIVE", "INACTIVE", "CREATING", "DELETED", "DELETING", "FAILED", "UPDATING", "NEEDS_ATTENTION", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The lifecycle_state of this Onboarding.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this Onboarding.
The current state of the Onboarding.
:param lifecycle_state: The lifecycle_state of this Onboarding.
:type: str
"""
allowed_values = ["ACTIVE", "INACTIVE", "CREATING", "DELETED", "DELETING", "FAILED", "UPDATING", "NEEDS_ATTENTION"]
if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
lifecycle_state = 'UNKNOWN_ENUM_VALUE'
self._lifecycle_state = lifecycle_state
@property
def system_tags(self):
"""
Gets the system_tags of this Onboarding.
System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
:return: The system_tags of this Onboarding.
:rtype: dict(str, dict(str, object))
"""
return self._system_tags
@system_tags.setter
def system_tags(self, system_tags):
"""
Sets the system_tags of this Onboarding.
System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
:param system_tags: The system_tags of this Onboarding.
:type: dict(str, dict(str, object))
"""
self._system_tags = system_tags
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this Onboarding.
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{\"bar-key\": \"value\"}`
:return: The freeform_tags of this Onboarding.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this Onboarding.
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{\"bar-key\": \"value\"}`
:param freeform_tags: The freeform_tags of this Onboarding.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
Gets the defined_tags of this Onboarding.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
:return: The defined_tags of this Onboarding.
: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 Onboarding.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
:param defined_tags: The defined_tags of this Onboarding.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
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