VbsInstance¶

class oci.vbs_inst.models.VbsInstance(**kwargs)¶

Bases: object

Visual Builder Studio service instance

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a VbsInstance.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a VbsInstance.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a VbsInstance.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a VbsInstance.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a VbsInstance.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a VbsInstance.
`compartment_id`	[Required] Gets the compartment_id of this VbsInstance.
`defined_tags`	Gets the defined_tags of this VbsInstance.
`display_name`	[Required] Gets the display_name of this VbsInstance.
`freeform_tags`	Gets the freeform_tags of this VbsInstance.
`id`	[Required] Gets the id of this VbsInstance.
`is_resource_usage_agreement_granted`	Gets the is_resource_usage_agreement_granted of this VbsInstance.
`lifecycle_state`	Gets the lifecycle_state of this VbsInstance.
`lifecyle_details`	Gets the lifecyle_details of this VbsInstance.
`name`	[Required] Gets the name of this VbsInstance.
`resource_compartment_id`	Gets the resource_compartment_id of this VbsInstance.
`system_tags`	Gets the system_tags of this VbsInstance.
`time_created`	Gets the time_created of this VbsInstance.
`time_updated`	Gets the time_updated of this VbsInstance.
`vbs_access_url`	Gets the vbs_access_url of this VbsInstance.

Methods

__init__(**kwargs) Initializes a new VbsInstance object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a VbsInstance. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a VbsInstance. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a VbsInstance. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a VbsInstance. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a VbsInstance. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a VbsInstance. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new VbsInstance 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 VbsInstance.
name (str) – The value to assign to the name property of this VbsInstance.
display_name (str) – The value to assign to the display_name property of this VbsInstance.
compartment_id (str) – The value to assign to the compartment_id property of this VbsInstance.
is_resource_usage_agreement_granted (bool) – The value to assign to the is_resource_usage_agreement_granted property of this VbsInstance.
resource_compartment_id (str) – The value to assign to the resource_compartment_id property of this VbsInstance.
vbs_access_url (str) – The value to assign to the vbs_access_url property of this VbsInstance.
time_created (datetime) – The value to assign to the time_created property of this VbsInstance.
time_updated (datetime) – The value to assign to the time_updated property of this VbsInstance.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this 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’.
lifecyle_details (str) – The value to assign to the lifecyle_details property of this VbsInstance.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VbsInstance.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VbsInstance.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VbsInstance.

compartment_id¶

[Required] Gets the compartment_id of this VbsInstance. Compartment of the service instance

Returns:	The compartment_id of this VbsInstance.
Return type:	str

defined_tags¶

Gets the defined_tags of this VbsInstance. 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 VbsInstance.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this VbsInstance. Service instance display name

Returns:	The display_name of this VbsInstance.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this VbsInstance. 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 VbsInstance.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this VbsInstance. Unique identifier that is immutable on creation

Returns:	The id of this VbsInstance.
Return type:	str

is_resource_usage_agreement_granted¶

Gets the is_resource_usage_agreement_granted of this VbsInstance. 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 VbsInstance.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this VbsInstance. 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 VbsInstance.
Return type:	str

lifecyle_details¶

Gets the lifecyle_details of this VbsInstance. 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 lifecyle_details of this VbsInstance.
Return type:	str

name¶

[Required] Gets the name of this VbsInstance. Service instance name (unique identifier)

Returns:	The name of this VbsInstance.
Return type:	str

resource_compartment_id¶

Gets the resource_compartment_id of this VbsInstance. Compartment where VBS may create additional resources for the service instance

Returns:	The resource_compartment_id of this VbsInstance.
Return type:	str

system_tags¶

Gets the system_tags of this VbsInstance. 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 VbsInstance.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this VbsInstance. The time the the VbsInstance was created. An RFC3339 formatted datetime string

Returns:	The time_created of this VbsInstance.
Return type:	datetime

time_updated¶

Gets the time_updated of this VbsInstance. The time the VbsInstance was updated. An RFC3339 formatted datetime string

Returns:	The time_updated of this VbsInstance.
Return type:	datetime

vbs_access_url¶

Gets the vbs_access_url of this VbsInstance. Public web URL for accessing the VBS service instance

Returns:	The vbs_access_url of this VbsInstance.
Return type:	str