Package com.oracle.bmc.fleetappsmanagement.model

Class SchemaDocument

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.fleetappsmanagement.model.SchemaDocument

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20250228")
public final class SchemaDocument
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Schema Document representing Schema.yaml (/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager_topic-schema.htm)
Note: Objects should always be created or deserialized using the SchemaDocument.Builder.

This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SchemaDocument.Builder, which maintain a set of all explicitly set fields called SchemaDocument.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SchemaDocument.Builder
static class	SchemaDocument.Locale	The locale/language for the schema user interface (default is EN).
static class	SchemaDocument.SchemaVersion	The version of the schema definition format in use for this document.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

SchemaDocument(String title, String description, String stackDescription, String packageVersion, String version, SchemaDocument.SchemaVersion schemaVersion, SchemaDocument.Locale locale, String logoUrl, StackSource source, String informationalText, String instructions, String troubleshooting, Boolean canAllowViewState, Map<String,BaseVariable> variables, VariableGroups groupings, List<VariableGroup> variableGroups, Map<String,BaseOutput> outputs, List<OutputGroup> outputGroups, String primaryOutputButton)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static SchemaDocument.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getCanAllowViewState()	Indicates if the stack allows users to view state information.
String	getDescription()	A detailed description of the stack or schema.
VariableGroups	getGroupings()
String	getInformationalText()	Informational text or notes relevant to the stack or its use.
String	getInstructions()	Setup or usage instructions for this stack.
SchemaDocument.Locale	getLocale()	The locale/language for the schema user interface (default is EN).
String	getLogoUrl()	logo url.
List<OutputGroup>	getOutputGroups()	Array of output group objects to group outputs for display or logical purposes.
Map<String,BaseOutput>	getOutputs()	A mapping of output variable names to their definitions.
String	getPackageVersion()	The version of the package associated with this schema.
String	getPrimaryOutputButton()	primary output button value.
SchemaDocument.SchemaVersion	getSchemaVersion()	The version of the schema definition format in use for this document.
StackSource	getSource()
String	getStackDescription()	Additional details describing the stack’s purpose or use-case.
String	getTitle()	The display name or title for this schema document.
String	getTroubleshooting()	Troubleshooting tips, guidance, or steps for stack usage.
List<VariableGroup>	getVariableGroups()	An array of variable group definitions for organizing variables together.
Map<String,BaseVariable>	getVariables()	Key-value map of input variables defined for use by the stack.
String	getVersion()	The version identifier for this schema document.
int	hashCode()
SchemaDocument.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SchemaDocument

@Deprecated
@ConstructorProperties({"title","description","stackDescription","packageVersion","version","schemaVersion","locale","logoUrl","source","informationalText","instructions","troubleshooting","canAllowViewState","variables","groupings","variableGroups","outputs","outputGroups","primaryOutputButton"})
public SchemaDocument(String title,
                      String description,
                      String stackDescription,
                      String packageVersion,
                      String version,
                      SchemaDocument.SchemaVersion schemaVersion,
                      SchemaDocument.Locale locale,
                      String logoUrl,
                      StackSource source,
                      String informationalText,
                      String instructions,
                      String troubleshooting,
                      Boolean canAllowViewState,
                      Map<String,BaseVariable> variables,
                      VariableGroups groupings,
                      List<VariableGroup> variableGroups,
                      Map<String,BaseOutput> outputs,
                      List<OutputGroup> outputGroups,
                      String primaryOutputButton)

Deprecated.

Method Detail

builder

public static SchemaDocument.Builder builder()

Create a new builder.

toBuilder

public SchemaDocument.Builder toBuilder()

getTitle

public String getTitle()

The display name or title for this schema document.

Returns:

the value

getDescription

public String getDescription()

A detailed description of the stack or schema.

Returns:

the value

getStackDescription

public String getStackDescription()

Additional details describing the stack’s purpose or use-case.

Returns:

the value

getPackageVersion

public String getPackageVersion()

The version of the package associated with this schema.

Returns:

the value

getVersion

public String getVersion()

The version identifier for this schema document.

Returns:

the value

getSchemaVersion

public SchemaDocument.SchemaVersion getSchemaVersion()

The version of the schema definition format in use for this document.

Returns:

the value

getLocale

public SchemaDocument.Locale getLocale()

The locale/language for the schema user interface (default is EN).

Returns:

the value

getLogoUrl

public String getLogoUrl()

logo url.

Returns:

the value

getSource

public StackSource getSource()

getInformationalText

public String getInformationalText()

Informational text or notes relevant to the stack or its use.

Returns:

the value

getInstructions

public String getInstructions()

Setup or usage instructions for this stack.

Returns:

the value

getTroubleshooting

public String getTroubleshooting()

Troubleshooting tips, guidance, or steps for stack usage.

Returns:

the value

getCanAllowViewState

public Boolean getCanAllowViewState()

Indicates if the stack allows users to view state information.

Returns:

the value

getVariables

public Map<String,BaseVariable> getVariables()

Key-value map of input variables defined for use by the stack.

Returns:

the value

getGroupings

public VariableGroups getGroupings()

getVariableGroups

public List<VariableGroup> getVariableGroups()

An array of variable group definitions for organizing variables together.

Returns:

the value

getOutputs

public Map<String,BaseOutput> getOutputs()

A mapping of output variable names to their definitions.

Returns:

the value

getOutputGroups

public List<OutputGroup> getOutputGroups()

Array of output group objects to group outputs for display or logical purposes.

Returns:

the value

getPrimaryOutputButton

public String getPrimaryOutputButton()

primary output button value.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel