OnPremConnectorSummary¶
- class oci.data_safe.models.OnPremConnectorSummary(**kwargs)¶
Bases:
objectSummary of a Data Safe on-premises connector.
Attributes:
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary.
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary.
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary.
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary.
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary.
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary.
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary.
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary.
[Required] Gets the compartment_id of this OnPremConnectorSummary.
Gets the created_version of this OnPremConnectorSummary.
Gets the defined_tags of this OnPremConnectorSummary.
Gets the description of this OnPremConnectorSummary.
[Required] Gets the display_name of this OnPremConnectorSummary.
Gets the freeform_tags of this OnPremConnectorSummary.
[Required] Gets the id of this OnPremConnectorSummary.
Gets the lifecycle_details of this OnPremConnectorSummary.
[Required] Gets the lifecycle_state of this OnPremConnectorSummary.
Gets the system_tags of this OnPremConnectorSummary.
[Required] Gets the time_created of this OnPremConnectorSummary.
Methods:
__init__(**kwargs)Initializes a new OnPremConnectorSummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a OnPremConnectorSummary. 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 OnPremConnectorSummary. 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 OnPremConnectorSummary. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new OnPremConnectorSummary 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 OnPremConnectorSummary.
display_name (str) – The value to assign to the display_name property of this OnPremConnectorSummary.
compartment_id (str) – The value to assign to the compartment_id property of this OnPremConnectorSummary.
description (str) – The value to assign to the description property of this OnPremConnectorSummary.
time_created (datetime) – The value to assign to the time_created property of this OnPremConnectorSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OnPremConnectorSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this OnPremConnectorSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OnPremConnectorSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OnPremConnectorSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OnPremConnectorSummary.
created_version (str) – The value to assign to the created_version property of this OnPremConnectorSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this OnPremConnectorSummary. The OCID of the compartment that contains the on-premises connector.
- Returns
The compartment_id of this OnPremConnectorSummary.
- Return type
str
- property created_version¶
Gets the created_version of this OnPremConnectorSummary. Created version of the on-premises connector.
- Returns
The created_version of this OnPremConnectorSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this OnPremConnectorSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The defined_tags of this OnPremConnectorSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this OnPremConnectorSummary. The description of the on-premises connector.
- Returns
The description of this OnPremConnectorSummary.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this OnPremConnectorSummary. The display name of the on-premises connector.
- Returns
The display_name of this OnPremConnectorSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this OnPremConnectorSummary. 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”}
- Returns
The freeform_tags of this OnPremConnectorSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this OnPremConnectorSummary. The OCID of the on-premises connector.
- Returns
The id of this OnPremConnectorSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this OnPremConnectorSummary. Details about the current state of the on-premises connector.
- Returns
The lifecycle_details of this OnPremConnectorSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this OnPremConnectorSummary. The current state of the on-premises connector.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “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 OnPremConnectorSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this OnPremConnectorSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this OnPremConnectorSummary.
- Return type
dict(str, dict(str, object))