VbInstance¶

class oci.visual_builder.models.VbInstance(**kwargs)¶

Bases: object

Description of Vb Instance.

Attributes

`CONSUMPTION_MODEL_GOV`	A constant which can be used with the consumption_model property of a VbInstance.
`CONSUMPTION_MODEL_UCM`	A constant which can be used with the consumption_model property of a VbInstance.
`CONSUMPTION_MODEL_VB4_SAAS`	A constant which can be used with the consumption_model property of a VbInstance.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a VbInstance.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a VbInstance.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a VbInstance.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a VbInstance.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a VbInstance.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a VbInstance.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a VbInstance.
`alternate_custom_endpoints`	Gets the alternate_custom_endpoints of this VbInstance.
`attachments`	Gets the attachments of this VbInstance.
`compartment_id`	[Required] Gets the compartment_id of this VbInstance.
`consumption_model`	Gets the consumption_model of this VbInstance.
`custom_endpoint`	Gets the custom_endpoint of this VbInstance.
`defined_tags`	Gets the defined_tags of this VbInstance.
`display_name`	[Required] Gets the display_name of this VbInstance.
`freeform_tags`	Gets the freeform_tags of this VbInstance.
`id`	[Required] Gets the id of this VbInstance.
`idcs_info`	Gets the idcs_info of this VbInstance.
`instance_url`	[Required] Gets the instance_url of this VbInstance.
`is_visual_builder_enabled`	Gets the is_visual_builder_enabled of this VbInstance.
`lifecycle_state`	[Required] Gets the lifecycle_state of this VbInstance.
`management_nat_gateway_ip`	Gets the management_nat_gateway_ip of this VbInstance.
`management_vcn_id`	Gets the management_vcn_id of this VbInstance.
`node_count`	[Required] Gets the node_count of this VbInstance.
`service_nat_gateway_ip`	Gets the service_nat_gateway_ip of this VbInstance.
`service_vcn_id`	Gets the service_vcn_id of this VbInstance.
`state_message`	Gets the state_message of this VbInstance.
`system_tags`	Gets the system_tags of this VbInstance.
`time_created`	Gets the time_created of this VbInstance.
`time_updated`	Gets the time_updated of this VbInstance.

Methods

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

CONSUMPTION_MODEL_GOV = 'GOV'¶: A constant which can be used with the consumption_model property of a VbInstance. This constant has a value of “GOV”

CONSUMPTION_MODEL_UCM = 'UCM'¶: A constant which can be used with the consumption_model property of a VbInstance. This constant has a value of “UCM”

CONSUMPTION_MODEL_VB4_SAAS = 'VB4SAAS'¶: A constant which can be used with the consumption_model property of a VbInstance. This constant has a value of “VB4SAAS”

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

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a VbInstance. This constant has a value of “INACTIVE”

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

__init__(**kwargs)¶

Initializes a new VbInstance 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 VbInstance.
display_name (str) – The value to assign to the display_name property of this VbInstance.
compartment_id (str) – The value to assign to the compartment_id property of this VbInstance.
time_created (datetime) – The value to assign to the time_created property of this VbInstance.
time_updated (datetime) – The value to assign to the time_updated property of this VbInstance.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VbInstance. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
state_message (str) – The value to assign to the state_message property of this VbInstance.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VbInstance.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VbInstance.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VbInstance.
instance_url (str) – The value to assign to the instance_url property of this VbInstance.
node_count (int) – The value to assign to the node_count property of this VbInstance.
is_visual_builder_enabled (bool) – The value to assign to the is_visual_builder_enabled property of this VbInstance.
custom_endpoint (oci.visual_builder.models.CustomEndpointDetails) – The value to assign to the custom_endpoint property of this VbInstance.
alternate_custom_endpoints (list[oci.visual_builder.models.CustomEndpointDetails]) – The value to assign to the alternate_custom_endpoints property of this VbInstance.
consumption_model (str) – The value to assign to the consumption_model property of this VbInstance. Allowed values for this property are: “UCM”, “GOV”, “VB4SAAS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
idcs_info (oci.visual_builder.models.IdcsInfoDetails) – The value to assign to the idcs_info property of this VbInstance.
attachments (list[oci.visual_builder.models.AttachmentDetails]) – The value to assign to the attachments property of this VbInstance.
service_nat_gateway_ip (str) – The value to assign to the service_nat_gateway_ip property of this VbInstance.
management_nat_gateway_ip (str) – The value to assign to the management_nat_gateway_ip property of this VbInstance.
service_vcn_id (str) – The value to assign to the service_vcn_id property of this VbInstance.
management_vcn_id (str) – The value to assign to the management_vcn_id property of this VbInstance.

alternate_custom_endpoints¶

Gets the alternate_custom_endpoints of this VbInstance. A list of alternate custom endpoints used for the vb instance URL.

Returns:	The alternate_custom_endpoints of this VbInstance.
Return type:	list[oci.visual_builder.models.CustomEndpointDetails]

attachments¶

Gets the attachments of this VbInstance. A list of associated attachments to other services

Returns:	The attachments of this VbInstance.
Return type:	list[oci.visual_builder.models.AttachmentDetails]

compartment_id¶

[Required] Gets the compartment_id of this VbInstance. Compartment Identifier.

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

consumption_model¶

Gets the consumption_model of this VbInstance. The entitlement used for billing purposes.

Allowed values for this property are: “UCM”, “GOV”, “VB4SAAS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The consumption_model of this VbInstance.
Return type:	str

custom_endpoint¶

Gets the custom_endpoint of this VbInstance.

Returns:	The custom_endpoint of this VbInstance.
Return type:	oci.visual_builder.models.CustomEndpointDetails

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this VbInstance. Vb Instance Identifier, can be renamed.

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

freeform_tags¶

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

id¶

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

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

idcs_info¶

Gets the idcs_info of this VbInstance.

Returns:	The idcs_info of this VbInstance.
Return type:	oci.visual_builder.models.IdcsInfoDetails

instance_url¶

[Required] Gets the instance_url of this VbInstance. The Vb Instance URL.

Returns:	The instance_url of this VbInstance.
Return type:	str

is_visual_builder_enabled¶

Gets the is_visual_builder_enabled of this VbInstance. Visual Builder is enabled or not.

Returns:	The is_visual_builder_enabled of this VbInstance.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this VbInstance. The current state of the vb instance.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 VbInstance.
Return type:	str

management_nat_gateway_ip¶

Gets the management_nat_gateway_ip of this VbInstance. The NAT gateway IP address for the VB management VCN

Returns:	The management_nat_gateway_ip of this VbInstance.
Return type:	str

management_vcn_id¶

Gets the management_vcn_id of this VbInstance. The Oracle Cloud ID (OCID) of the Visual Builder management VCN

Returns:	The management_vcn_id of this VbInstance.
Return type:	str

node_count¶

[Required] Gets the node_count of this VbInstance. The number of Nodes

Returns:	The node_count of this VbInstance.
Return type:	int

service_nat_gateway_ip¶

Gets the service_nat_gateway_ip of this VbInstance. The NAT gateway IP address for the VB service VCN

Returns:	The service_nat_gateway_ip of this VbInstance.
Return type:	str

service_vcn_id¶

Gets the service_vcn_id of this VbInstance. The Oracle Cloud ID (OCID) of the Visual Builder service VCN

Returns:	The service_vcn_id of this VbInstance.
Return type:	str

state_message¶

Gets the state_message of this VbInstance. An 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 state_message of this VbInstance.
Return type:	str

system_tags¶

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

time_created¶

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

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

time_updated¶

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

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