Onboarding¶
- class oci.fleet_apps_management.models.Onboarding(**kwargs)¶
Bases:
objectFleet Application Management onboarding resource. The onboarding process lets Fleet Application Management create a few required policies that you need to start using it and its features.
Attributes:
A constant which can be used with the lifecycle_state property of a Onboarding.
A constant which can be used with the lifecycle_state property of a Onboarding.
A constant which can be used with the lifecycle_state property of a Onboarding.
A constant which can be used with the lifecycle_state property of a Onboarding.
A constant which can be used with the lifecycle_state property of a Onboarding.
A constant which can be used with the lifecycle_state property of a Onboarding.
A constant which can be used with the lifecycle_state property of a Onboarding.
A constant which can be used with the lifecycle_state property of a Onboarding.
Gets the applied_policies of this Onboarding.
[Required] Gets the compartment_id of this Onboarding.
Gets the defined_tags of this Onboarding.
Gets the discovery_frequency of this Onboarding.
Gets the freeform_tags of this Onboarding.
[Required] Gets the id of this Onboarding.
Gets the is_cost_tracking_tag_enabled of this Onboarding.
Gets the is_fams_tag_enabled of this Onboarding.
[Required] Gets the lifecycle_state of this Onboarding.
Gets the resource_region of this Onboarding.
Gets the system_tags of this Onboarding.
Gets the time_created of this Onboarding.
Gets the time_updated of this Onboarding.
Gets the version of this Onboarding.
Methods:
__init__(**kwargs)Initializes a new Onboarding object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Onboarding. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Onboarding. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Onboarding. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Onboarding. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Onboarding. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a Onboarding. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶
A constant which can be used with the lifecycle_state property of a Onboarding. This constant has a value of “NEEDS_ATTENTION”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a Onboarding. This constant has a value of “UPDATING”
- __init__(**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):
- Parameters
id (str) – The value to assign to the id property of this Onboarding.
compartment_id (str) – The value to assign to the compartment_id property of this Onboarding.
resource_region (str) – The value to assign to the resource_region property of this Onboarding.
time_created (datetime) – The value to assign to the time_created property of this Onboarding.
time_updated (datetime) – The value to assign to the time_updated property of this Onboarding.
is_fams_tag_enabled (bool) – The value to assign to the is_fams_tag_enabled property of this Onboarding.
version (str) – The value to assign to the version property of this Onboarding.
is_cost_tracking_tag_enabled (bool) – The value to assign to the is_cost_tracking_tag_enabled property of this Onboarding.
applied_policies (oci.fleet_apps_management.models.OnboardingPolicySummary) – The value to assign to the applied_policies property of this Onboarding.
discovery_frequency (str) – The value to assign to the discovery_frequency property of this Onboarding.
lifecycle_state (str) – 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’.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Onboarding.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Onboarding.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Onboarding.
- property applied_policies¶
Gets the applied_policies of this Onboarding.
- Returns
The applied_policies of this Onboarding.
- Return type
- property compartment_id¶
[Required] Gets the compartment_id of this Onboarding. Tenancy OCID
- Returns
The compartment_id of this Onboarding.
- Return type
str
- property defined_tags¶
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”}}
- Returns
The defined_tags of this Onboarding.
- Return type
dict(str, dict(str, object))
- property discovery_frequency¶
Gets the discovery_frequency of this Onboarding. Provide discovery frequency.
- Returns
The discovery_frequency of this Onboarding.
- Return type
str
- property freeform_tags¶
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”}
- Returns
The freeform_tags of this Onboarding.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this Onboarding. The unique id of the resource.
- Returns
The id of this Onboarding.
- Return type
str
- property is_cost_tracking_tag_enabled¶
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.
- Returns
The is_cost_tracking_tag_enabled of this Onboarding.
- Return type
bool
- property is_fams_tag_enabled¶
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.
- Returns
The is_fams_tag_enabled of this Onboarding.
- Return type
bool
- property lifecycle_state¶
[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’.
- Returns
The lifecycle_state of this Onboarding.
- Return type
str
- property resource_region¶
Gets the resource_region of this Onboarding. Associated region
- Returns
The resource_region of this Onboarding.
- Return type
str
- property system_tags¶
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”}}
- Returns
The system_tags of this Onboarding.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this Onboarding. The time this resource was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this Onboarding.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this Onboarding. The time this resource was last updated. An RFC3339 formatted datetime string.
- Returns
The time_updated of this Onboarding.
- Return type
datetime
- property version¶
Gets the version of this Onboarding. The version of Fleet Application Management that the tenant is onboarded to.
- Returns
The version of this Onboarding.
- Return type
str