SchemaDocument

class oci.fleet_apps_management.models.SchemaDocument(**kwargs)

Bases: object

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

Attributes:

LOCALE_EN

A constant which can be used with the locale property of a SchemaDocument.

SCHEMA_VERSION_V_1_0_0

A constant which can be used with the schema_version property of a SchemaDocument.

SCHEMA_VERSION_V_1_1_0

A constant which can be used with the schema_version property of a SchemaDocument.

can_allow_view_state

Gets the can_allow_view_state of this SchemaDocument.

description

Gets the description of this SchemaDocument.

groupings

Gets the groupings of this SchemaDocument.

informational_text

Gets the informational_text of this SchemaDocument.

instructions

Gets the instructions of this SchemaDocument.

locale

Gets the locale of this SchemaDocument.

logo_url

Gets the logo_url of this SchemaDocument.

output_groups

Gets the output_groups of this SchemaDocument.

outputs

Gets the outputs of this SchemaDocument.

package_version

Gets the package_version of this SchemaDocument.

primary_output_button

Gets the primary_output_button of this SchemaDocument.

schema_version

[Required] Gets the schema_version of this SchemaDocument.

source

Gets the source of this SchemaDocument.

stack_description

Gets the stack_description of this SchemaDocument.

title

Gets the title of this SchemaDocument.

troubleshooting

Gets the troubleshooting of this SchemaDocument.

variable_groups

Gets the variable_groups of this SchemaDocument.

variables

[Required] Gets the variables of this SchemaDocument.

version

Gets the version of this SchemaDocument.

Methods:

__init__(**kwargs)

Initializes a new SchemaDocument object with values from keyword arguments.

LOCALE_EN = 'EN'

A constant which can be used with the locale property of a SchemaDocument. This constant has a value of “EN”

SCHEMA_VERSION_V_1_0_0 = 'V_1_0_0'

A constant which can be used with the schema_version property of a SchemaDocument. This constant has a value of “V_1_0_0”

SCHEMA_VERSION_V_1_1_0 = 'V_1_1_0'

A constant which can be used with the schema_version property of a SchemaDocument. This constant has a value of “V_1_1_0”

__init__(**kwargs)

Initializes a new SchemaDocument object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • title (str) – The value to assign to the title property of this SchemaDocument.

  • description (str) – The value to assign to the description property of this SchemaDocument.

  • stack_description (str) – The value to assign to the stack_description property of this SchemaDocument.

  • package_version (str) – The value to assign to the package_version property of this SchemaDocument.

  • version (str) – The value to assign to the version property of this SchemaDocument.

  • schema_version (str) – The value to assign to the schema_version property of this SchemaDocument. Allowed values for this property are: “V_1_0_0”, “V_1_1_0”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • locale (str) – The value to assign to the locale property of this SchemaDocument. Allowed values for this property are: “EN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • logo_url (str) – The value to assign to the logo_url property of this SchemaDocument.

  • source (oci.fleet_apps_management.models.StackSource) – The value to assign to the source property of this SchemaDocument.

  • informational_text (str) – The value to assign to the informational_text property of this SchemaDocument.

  • instructions (str) – The value to assign to the instructions property of this SchemaDocument.

  • troubleshooting (str) – The value to assign to the troubleshooting property of this SchemaDocument.

  • can_allow_view_state (bool) – The value to assign to the can_allow_view_state property of this SchemaDocument.

  • variables (dict(str, BaseVariable)) – The value to assign to the variables property of this SchemaDocument.

  • groupings (oci.fleet_apps_management.models.VariableGroups) – The value to assign to the groupings property of this SchemaDocument.

  • variable_groups (list[oci.fleet_apps_management.models.VariableGroup]) – The value to assign to the variable_groups property of this SchemaDocument.

  • outputs (dict(str, BaseOutput)) – The value to assign to the outputs property of this SchemaDocument.

  • output_groups (list[oci.fleet_apps_management.models.OutputGroup]) – The value to assign to the output_groups property of this SchemaDocument.

  • primary_output_button (str) – The value to assign to the primary_output_button property of this SchemaDocument.

property can_allow_view_state

Gets the can_allow_view_state of this SchemaDocument. Indicates if the stack allows users to view state information.

Returns

The can_allow_view_state of this SchemaDocument.

Return type

bool

property description

Gets the description of this SchemaDocument. A detailed description of the stack or schema.

Returns

The description of this SchemaDocument.

Return type

str

property groupings

Gets the groupings of this SchemaDocument.

Returns

The groupings of this SchemaDocument.

Return type

oci.fleet_apps_management.models.VariableGroups

property informational_text

Gets the informational_text of this SchemaDocument. Informational text or notes relevant to the stack or its use.

Returns

The informational_text of this SchemaDocument.

Return type

str

property instructions

Gets the instructions of this SchemaDocument. Setup or usage instructions for this stack.

Returns

The instructions of this SchemaDocument.

Return type

str

property locale

Gets the locale of this SchemaDocument. The locale/language for the schema user interface (default is EN).

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

Returns

The locale of this SchemaDocument.

Return type

str

property logo_url

Gets the logo_url of this SchemaDocument. logo url.

Returns

The logo_url of this SchemaDocument.

Return type

str

property output_groups

Gets the output_groups of this SchemaDocument. Array of output group objects to group outputs for display or logical purposes.

Returns

The output_groups of this SchemaDocument.

Return type

list[oci.fleet_apps_management.models.OutputGroup]

property outputs

Gets the outputs of this SchemaDocument. A mapping of output variable names to their definitions.

Returns

The outputs of this SchemaDocument.

Return type

dict(str, BaseOutput)

property package_version

Gets the package_version of this SchemaDocument. The version of the package associated with this schema.

Returns

The package_version of this SchemaDocument.

Return type

str

property primary_output_button

Gets the primary_output_button of this SchemaDocument. primary output button value.

Returns

The primary_output_button of this SchemaDocument.

Return type

str

property schema_version

[Required] Gets the schema_version of this SchemaDocument. The version of the schema definition format in use for this document.

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

Returns

The schema_version of this SchemaDocument.

Return type

str

property source

Gets the source of this SchemaDocument.

Returns

The source of this SchemaDocument.

Return type

oci.fleet_apps_management.models.StackSource

property stack_description

Gets the stack_description of this SchemaDocument. Additional details describing the stack’s purpose or use-case.

Returns

The stack_description of this SchemaDocument.

Return type

str

property title

Gets the title of this SchemaDocument. The display name or title for this schema document.

Returns

The title of this SchemaDocument.

Return type

str

property troubleshooting

Gets the troubleshooting of this SchemaDocument. Troubleshooting tips, guidance, or steps for stack usage.

Returns

The troubleshooting of this SchemaDocument.

Return type

str

property variable_groups

Gets the variable_groups of this SchemaDocument. An array of variable group definitions for organizing variables together.

Returns

The variable_groups of this SchemaDocument.

Return type

list[oci.fleet_apps_management.models.VariableGroup]

property variables

[Required] Gets the variables of this SchemaDocument. Key-value map of input variables defined for use by the stack.

Returns

The variables of this SchemaDocument.

Return type

dict(str, BaseVariable)

property version

Gets the version of this SchemaDocument. The version identifier for this schema document.

Returns

The version of this SchemaDocument.

Return type

str