Class SchemaDocument

Schema Document representing Schema.yaml (/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager_topic-schema.htm)

Inheritance

object

SchemaDocument

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.FleetappsmanagementService.Models

Assembly: OCI.DotNetSDK.Fleetappsmanagement.dll

Syntax

public class SchemaDocument

Properties

CanAllowViewState

Declaration

[JsonProperty(PropertyName = "canAllowViewState")]
public bool? CanAllowViewState { get; set; }

Property Value

Type	Description
bool?	Indicates if the stack allows users to view state information.

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	A detailed description of the stack or schema.

Groupings

Declaration

[JsonProperty(PropertyName = "groupings")]
public VariableGroups Groupings { get; set; }

Property Value

Type	Description
VariableGroups

InformationalText

Declaration

[JsonProperty(PropertyName = "informationalText")]
public string InformationalText { get; set; }

Property Value

Type	Description
string	Informational text or notes relevant to the stack or its use.

Instructions

Declaration

[JsonProperty(PropertyName = "instructions")]
public string Instructions { get; set; }

Property Value

Type	Description
string	Setup or usage instructions for this stack.

Locale

Declaration

[JsonProperty(PropertyName = "locale")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SchemaDocument.LocaleEnum? Locale { get; set; }

Property Value

Type	Description
SchemaDocument.LocaleEnum?	The locale/language for the schema user interface (default is EN).

LogoUrl

Declaration

[JsonProperty(PropertyName = "logoUrl")]
public string LogoUrl { get; set; }

Property Value

Type	Description
string	logo url.

OutputGroups

Declaration

[JsonProperty(PropertyName = "outputGroups")]
public List<OutputGroup> OutputGroups { get; set; }

Property Value

Type	Description
List<OutputGroup>	Array of output group objects to group outputs for display or logical purposes.

Outputs

Declaration

[JsonProperty(PropertyName = "outputs")]
public Dictionary<string, BaseOutput> Outputs { get; set; }

Property Value

Type	Description
Dictionary<string, BaseOutput>	A mapping of output variable names to their definitions.

PackageVersion

Declaration

[JsonProperty(PropertyName = "packageVersion")]
public string PackageVersion { get; set; }

Property Value

Type	Description
string	The version of the package associated with this schema.

PrimaryOutputButton

Declaration

[JsonProperty(PropertyName = "primaryOutputButton")]
public string PrimaryOutputButton { get; set; }

Property Value

Type	Description
string	primary output button value.

SchemaVersion

Declaration

[Required(ErrorMessage = "SchemaVersion is required.")]
[JsonProperty(PropertyName = "schemaVersion")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SchemaDocument.SchemaVersionEnum? SchemaVersion { get; set; }

Property Value

Type	Description
SchemaDocument.SchemaVersionEnum?	The version of the schema definition format in use for this document.

Remarks

Required

Source

Declaration

[JsonProperty(PropertyName = "source")]
public StackSource Source { get; set; }

Property Value

Type	Description
StackSource

StackDescription

Declaration

[JsonProperty(PropertyName = "stackDescription")]
public string StackDescription { get; set; }

Property Value

Type	Description
string	Additional details describing the stack's purpose or use-case.

Title

Declaration

[JsonProperty(PropertyName = "title")]
public string Title { get; set; }

Property Value

Type	Description
string	The display name or title for this schema document.

Troubleshooting

Declaration

[JsonProperty(PropertyName = "troubleshooting")]
public string Troubleshooting { get; set; }

Property Value

Type	Description
string	Troubleshooting tips, guidance, or steps for stack usage.

VariableGroups

Declaration

[JsonProperty(PropertyName = "variableGroups")]
public List<VariableGroup> VariableGroups { get; set; }

Property Value

Type	Description
List<VariableGroup>	An array of variable group definitions for organizing variables together.

Variables

Declaration

[Required(ErrorMessage = "Variables is required.")]
[JsonProperty(PropertyName = "variables")]
public Dictionary<string, BaseVariable> Variables { get; set; }

Property Value

Type	Description
Dictionary<string, BaseVariable>	Key-value map of input variables defined for use by the stack.

Remarks

Required

Version

Declaration

[JsonProperty(PropertyName = "version")]
public string Version { get; set; }

Property Value

Type	Description
string	The version identifier for this schema document.