VbsInstanceSummary¶
- class oci.vbs_inst.models.VbsInstanceSummary(**kwargs)¶
Bases:
objectSummary of the Visual Builder Studio service instance
Attributes:
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary.
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary.
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary.
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary.
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary.
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary.
[Required] Gets the compartment_id of this VbsInstanceSummary.
Gets the defined_tags of this VbsInstanceSummary.
[Required] Gets the display_name of this VbsInstanceSummary.
Gets the freeform_tags of this VbsInstanceSummary.
[Required] Gets the id of this VbsInstanceSummary.
Gets the is_resource_usage_agreement_granted of this VbsInstanceSummary.
Gets the lifecycle_details of this VbsInstanceSummary.
Gets the lifecycle_state of this VbsInstanceSummary.
[Required] Gets the name of this VbsInstanceSummary.
Gets the system_tags of this VbsInstanceSummary.
Gets the time_created of this VbsInstanceSummary.
Gets the time_updated of this VbsInstanceSummary.
Methods:
__init__(**kwargs)Initializes a new VbsInstanceSummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a VbsInstanceSummary. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new VbsInstanceSummary 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 VbsInstanceSummary.
name (str) – The value to assign to the name property of this VbsInstanceSummary.
display_name (str) – The value to assign to the display_name property of this VbsInstanceSummary.
compartment_id (str) – The value to assign to the compartment_id property of this VbsInstanceSummary.
is_resource_usage_agreement_granted (bool) – The value to assign to the is_resource_usage_agreement_granted property of this VbsInstanceSummary.
time_created (datetime) – The value to assign to the time_created property of this VbsInstanceSummary.
time_updated (datetime) – The value to assign to the time_updated property of this VbsInstanceSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VbsInstanceSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘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 VbsInstanceSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VbsInstanceSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VbsInstanceSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VbsInstanceSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this VbsInstanceSummary. Compartment of the service instance
- Returns
The compartment_id of this VbsInstanceSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this VbsInstanceSummary. 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 VbsInstanceSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this VbsInstanceSummary. Service instance display name
- Returns
The display_name of this VbsInstanceSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this VbsInstanceSummary. 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 VbsInstanceSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this VbsInstanceSummary. Unique identifier that is immutable on creation
- Returns
The id of this VbsInstanceSummary.
- Return type
str
- property is_resource_usage_agreement_granted¶
Gets the is_resource_usage_agreement_granted of this VbsInstanceSummary. Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy
- Returns
The is_resource_usage_agreement_granted of this VbsInstanceSummary.
- Return type
bool
- property lifecycle_details¶
Gets the lifecycle_details of this VbsInstanceSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Returns
The lifecycle_details of this VbsInstanceSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this VbsInstanceSummary. The current state of the VbsInstance.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this VbsInstanceSummary.
- Return type
str
- property name¶
[Required] Gets the name of this VbsInstanceSummary. Service instance name (unique identifier)
- Returns
The name of this VbsInstanceSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this VbsInstanceSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this VbsInstanceSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this VbsInstanceSummary. The time the the VbsInstance was created. An RFC3339 formatted datetime string
- Returns
The time_created of this VbsInstanceSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this VbsInstanceSummary. The time the VbsInstance was updated. An RFC3339 formatted datetime string
- Returns
The time_updated of this VbsInstanceSummary.
- Return type
datetime