Show / Hide Table of Contents

Class VbInstanceSummary

Summary of the Vb Instance.

Inheritance
object
VbInstanceSummary
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.VisualbuilderService.Models
Assembly: OCI.DotNetSDK.Visualbuilder.dll
Syntax
public class VbInstanceSummary

Properties

AlternateCustomEndpoints

Declaration
[JsonProperty(PropertyName = "alternateCustomEndpoints")]
public List<CustomEndpointDetails> AlternateCustomEndpoints { get; set; }
Property Value
Type Description
List<CustomEndpointDetails>

A list of alternate custom endpoints used for the vb instance URL.

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

Compartment Identifier.

Remarks

Required

ConsumptionModel

Declaration
[JsonProperty(PropertyName = "consumptionModel")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VbInstanceSummary.ConsumptionModelEnum? ConsumptionModel { get; set; }
Property Value
Type Description
VbInstanceSummary.ConsumptionModelEnum?

The entitlement used for billing purposes.

CustomEndpoint

Declaration
[JsonProperty(PropertyName = "customEndpoint")]
public CustomEndpointDetails CustomEndpoint { get; set; }
Property Value
Type Description
CustomEndpointDetails

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

Vb Instance Identifier, can be renamed.

Remarks

Required

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

Unique identifier that is immutable on creation.

Remarks

Required

InstanceUrl

Declaration
[Required(ErrorMessage = "InstanceUrl is required.")]
[JsonProperty(PropertyName = "instanceUrl")]
public string InstanceUrl { get; set; }
Property Value
Type Description
string

The Vb Instance URL.

Remarks

Required

IsVisualBuilderEnabled

Declaration
[JsonProperty(PropertyName = "isVisualBuilderEnabled")]
public bool? IsVisualBuilderEnabled { get; set; }
Property Value
Type Description
bool?

Visual Builder is enabled or not.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VbInstanceSummary.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
VbInstanceSummary.LifecycleStateEnum?

The current state of the Vb Instance.

Remarks

Required

NetworkEndpointDetails

Declaration
[JsonProperty(PropertyName = "networkEndpointDetails")]
public NetworkEndpointDetails NetworkEndpointDetails { get; set; }
Property Value
Type Description
NetworkEndpointDetails

NodeCount

Declaration
[Required(ErrorMessage = "NodeCount is required.")]
[JsonProperty(PropertyName = "nodeCount")]
public int? NodeCount { get; set; }
Property Value
Type Description
int?

The number of Nodes

Remarks

Required

StateMessage

Declaration
[JsonProperty(PropertyName = "stateMessage")]
public string StateMessage { get; set; }
Property Value
Type Description
string

An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The time the the Vb Instance was created. An RFC3339 formatted datetime string.

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The time the VbInstance was updated. An RFC3339 formatted datetime string.

In this article
Back to top