Package com.oracle.bmc.fleetappsmanagement.model

Class SchemaDocument.Builder

java.lang.Object

com.oracle.bmc.fleetappsmanagement.model.SchemaDocument.Builder

Enclosing class:

SchemaDocument

public static class SchemaDocument.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SchemaDocument	build()
SchemaDocument.Builder	canAllowViewState(Boolean canAllowViewState)	Indicates if the stack allows users to view state information.
SchemaDocument.Builder	copy(SchemaDocument model)
SchemaDocument.Builder	description(String description)	A detailed description of the stack or schema.
SchemaDocument.Builder	groupings(VariableGroups groupings)
SchemaDocument.Builder	informationalText(String informationalText)	Informational text or notes relevant to the stack or its use.
SchemaDocument.Builder	instructions(String instructions)	Setup or usage instructions for this stack.
SchemaDocument.Builder	locale(SchemaDocument.Locale locale)	The locale/language for the schema user interface (default is EN).
SchemaDocument.Builder	logoUrl(String logoUrl)	logo url.
SchemaDocument.Builder	outputGroups(List<OutputGroup> outputGroups)	Array of output group objects to group outputs for display or logical purposes.
SchemaDocument.Builder	outputs(Map<String,BaseOutput> outputs)	A mapping of output variable names to their definitions.
SchemaDocument.Builder	packageVersion(String packageVersion)	The version of the package associated with this schema.
SchemaDocument.Builder	primaryOutputButton(String primaryOutputButton)	primary output button value.
SchemaDocument.Builder	schemaVersion(SchemaDocument.SchemaVersion schemaVersion)	The version of the schema definition format in use for this document.
SchemaDocument.Builder	source(StackSource source)
SchemaDocument.Builder	stackDescription(String stackDescription)	Additional details describing the stack’s purpose or use-case.
SchemaDocument.Builder	title(String title)	The display name or title for this schema document.
SchemaDocument.Builder	troubleshooting(String troubleshooting)	Troubleshooting tips, guidance, or steps for stack usage.
SchemaDocument.Builder	variableGroups(List<VariableGroup> variableGroups)	An array of variable group definitions for organizing variables together.
SchemaDocument.Builder	variables(Map<String,BaseVariable> variables)	Key-value map of input variables defined for use by the stack.
SchemaDocument.Builder	version(String version)	The version identifier for this schema document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

title

public SchemaDocument.Builder title(String title)

The display name or title for this schema document.

Parameters:

title - the value to set

Returns:

this builder

description

public SchemaDocument.Builder description(String description)

A detailed description of the stack or schema.

Parameters:

description - the value to set

Returns:

this builder

stackDescription

public SchemaDocument.Builder stackDescription(String stackDescription)

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

Parameters:

stackDescription - the value to set

Returns:

this builder

packageVersion

public SchemaDocument.Builder packageVersion(String packageVersion)

The version of the package associated with this schema.

Parameters:

packageVersion - the value to set

Returns:

this builder

version

public SchemaDocument.Builder version(String version)

The version identifier for this schema document.

Parameters:

version - the value to set

Returns:

this builder

schemaVersion

public SchemaDocument.Builder schemaVersion(SchemaDocument.SchemaVersion schemaVersion)

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

Parameters:

schemaVersion - the value to set

Returns:

this builder

locale

public SchemaDocument.Builder locale(SchemaDocument.Locale locale)

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

Parameters:

locale - the value to set

Returns:

this builder

logoUrl

public SchemaDocument.Builder logoUrl(String logoUrl)

logo url.

Parameters:

logoUrl - the value to set

Returns:

this builder

source

public SchemaDocument.Builder source(StackSource source)

informationalText

public SchemaDocument.Builder informationalText(String informationalText)

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

Parameters:

informationalText - the value to set

Returns:

this builder

instructions

public SchemaDocument.Builder instructions(String instructions)

Setup or usage instructions for this stack.

Parameters:

instructions - the value to set

Returns:

this builder

troubleshooting

public SchemaDocument.Builder troubleshooting(String troubleshooting)

Troubleshooting tips, guidance, or steps for stack usage.

Parameters:

troubleshooting - the value to set

Returns:

this builder

canAllowViewState

public SchemaDocument.Builder canAllowViewState(Boolean canAllowViewState)

Indicates if the stack allows users to view state information.

Parameters:

canAllowViewState - the value to set

Returns:

this builder

variables

public SchemaDocument.Builder variables(Map<String,BaseVariable> variables)

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

Parameters:

variables - the value to set

Returns:

this builder

groupings

public SchemaDocument.Builder groupings(VariableGroups groupings)

variableGroups

public SchemaDocument.Builder variableGroups(List<VariableGroup> variableGroups)

An array of variable group definitions for organizing variables together.

Parameters:

variableGroups - the value to set

Returns:

this builder

outputs

public SchemaDocument.Builder outputs(Map<String,BaseOutput> outputs)

A mapping of output variable names to their definitions.

Parameters:

outputs - the value to set

Returns:

this builder

outputGroups

public SchemaDocument.Builder outputGroups(List<OutputGroup> outputGroups)

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

Parameters:

outputGroups - the value to set

Returns:

this builder

primaryOutputButton

public SchemaDocument.Builder primaryOutputButton(String primaryOutputButton)

primary output button value.

Parameters:

primaryOutputButton - the value to set

Returns:

this builder

build

public SchemaDocument build()

copy

public SchemaDocument.Builder copy(SchemaDocument model)