root
API
Generated with
root/besom/besom.codegen/besom.codegen.metaschema

besom.codegen.metaschema

package besom.codegen.metaschema

Members list

Type members

Classlikes

case class AliasDefinition(`type`: Option[String])

Value parameters

`type`

The type of the alias, if any

name

The name portion of the alias, if any

project

The project portion of the alias, if any

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AliasDefinition

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait AnonymousType extends TypeReference

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ArrayType
class MapType
object BooleanType.type
object IntegerType.type
object NumberType.type
object StringType.type
object ResourceIdType.type
class UnionType
object UrnType.type
Show all
trait AnonymousTypeProtoLike

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ArrayType(items: TypeReference) extends AnonymousType

A reference to an array type. The "type" property must be set to "array" and the "items" property must be present. No other properties may be present.

A reference to an array type. The "type" property must be set to "array" and the "items" property must be present. No other properties may be present.

Value parameters

items

"The element type of the array"

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BooleanConstValue(value: Boolean) extends ConstValue

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ConstValue
class Object
trait Matchable
class Any
Show all
object BooleanType extends PrimitiveType

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
Self type
case class ConfigDefinition(variables: Map[String, PropertyDefinition], defaults: List[String])

Config is the set of configuration properties defined by the package.

Config is the set of configuration properties defined by the package.

Value parameters

defaults

A list of the names of the package's non-required configuration variables.

variables

A map from variable name to propertySpec that describes a package's configuration variables.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConfigDefinition

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ConstValue

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ConstValue

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ConstValue.type
case class DefaultInfo(environment: List[String])

Additional information about the property's default value, if any.

Additional information about the property's default value, if any.

Value parameters

environment

A set of environment variables to probe for a default value.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DefaultInfo

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Discriminator(propertyName: String, mapping: Map[String, String])

Informs the consumer of an alternative schema based on the value associated with it

Informs the consumer of an alternative schema based on the value associated with it

Value parameters

mapping

an optional object to hold mappings between payload values and schema names or references

propertyName

PropertyName is the name of the property in the payload that will hold the discriminator value

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Discriminator

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class DoubleConstValue(value: Double) extends ConstValue

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ConstValue
class Object
trait Matchable
class Any
Show all
case class EnumTypeDefinition(enum: List[EnumValueDefinition], `type`: PrimitiveType, description: Option[String], isOverlay: Boolean) extends TypeDefinition

Describes a Pulumi metaschema enum type

Describes a Pulumi metaschema enum type

Value parameters

enum

The list of possible values for the enum

type

The underlying primitive type of the enum, one of: string, integer, number, boolean

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EnumValueDefinition(value: ConstValue, name: Option[String], description: Option[String], deprecationMessage: Option[String])

Describes a Pulumi metaschema enum value

Describes a Pulumi metaschema enum value

Value parameters

deprecationMessage

Indicates whether the value is deprecated

description

The description of the enum value, if any. Interpreted as Markdown

name

If present, overrides the name of the enum value that would usually be derived from the value

value

The enum value itself

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EnumValueDefinition

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class FunctionDefinition(description: Option[String], deprecationMessage: Option[String], isOverlay: Boolean, inputs: ObjectTypeDefinition, outputs: ObjectTypeDefinitionOrTypeReference, multiArgumentInputs: List[String])

Function describes a Pulumi function a.k.a. functionSpec.

Function describes a Pulumi function a.k.a. functionSpec.

Value parameters

deprecationMessage

Indicates whether the function is deprecated.

description

The description of the function, if any. Interpreted as Markdown.

inputs

The bag of input values for the function, if any.

isOverlay

Indicates that the implementation of the function should not be generated from the schema, and is instead provided out-of-band by the package author.

multiArgumentInputs

A list of parameter names that determines whether the input bag should be treated as a single argument or as multiple arguments. The list corresponds to the order in which the parameters should be passed to the function.

outputs

Specifies the return type of the function definition.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FunctionDefinition

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class IntConstValue(value: Int) extends ConstValue

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ConstValue
class Object
trait Matchable
class Any
Show all
object IntegerType extends PrimitiveType

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
Self type
case class Java(packages: Map[String, String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Java

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Java.type
case class Language(java: Java, nodejs: NodeJs)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Language

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Language.type
case class MapType(additionalProperties: TypeReference) extends AnonymousType

A reference to a map type. The "type" property must be set to "object" and the "additionalProperties" property may be present. No other properties may be present.

A reference to a map type. The "type" property must be set to "object" and the "additionalProperties" property may be present. No other properties may be present.

Value parameters

additionalProperties

The element type of the map. Defaults to "string" when omitted.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Meta(moduleFormat: String)

Format metadata about this package.

Format metadata about this package.

Value parameters

moduleFormat

A regex that is used by the importer to extract a module name from the module portion of a type token. Packages that use the module format "namespace1/namespace2/.../namespaceN" do not need to specify a format. The regex must define one capturing group that contains the module name, which must be formatted as "namespace1/namespace2/...namespaceN".

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Meta

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Meta.type
case class NamedType(typeUri: String, `type`: Option[AnonymousType]) extends TypeReference

A reference to a type in this or another document. The "ref" property must be present. The "type" property is ignored if it is present. No other properties may be present.

A reference to a type in this or another document. The "ref" property must be present. The "type" property is ignored if it is present. No other properties may be present.

Value parameters

`type`

ignored; present for compatibility with existing schemas

typeUri

The URI of the referenced type. For example, the built-in Archive, Asset, and Any types are referenced as "pulumi.json#/Archive", "pulumi.json#/Asset", and "pulumi.json#/Any", respectively. A type from this document is referenced as "#/types/pulumi:type:token". A type from another document is referenced as "path#/types/pulumi:type:token", where path is of the form: "/provider/vX.Y.Z/schema.json" or "pulumi.json" or "http[s]://example.com/provider/vX.Y.Z/schema.json".

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class NodeJs(moduleToPackage: Map[String, String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NodeJs

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
NodeJs.type
object NumberType extends PrimitiveType

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
Self type
NumberType.type
case class ObjectTypeDefinition(properties: Map[String, PropertyDefinition], required: List[String], description: Option[String], isOverlay: Boolean) extends TypeDefinition

Describes a Pulumi metaschema object type

Describes a Pulumi metaschema object type

Value parameters

properties

A map from property name to propertySpec that describes the object's properties

required

A list of the names of an object type's required properties. These properties must be set for inputs and will always be set for outputs

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ObjectTypeDefinition

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ObjectTypeDefinitionOrTypeReference(objectTypeDefinition: Option[ObjectTypeDefinition], typeReference: Option[TypeReference])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ObjectTypeDefinitionOrTypeReference

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ObjectTypeDefinitionOrTypeReferenceProto(properties: Map[String, PropertyDefinition], required: List[String], description: Option[String], isOverlay: Boolean, additionalProperties: Option[TypeReference], discriminator: Option[Discriminator], items: Option[TypeReference], oneOf: List[TypeReference], ref: Option[String], `type`: Option[String]) extends ObjectTypeDefinitionProtoLike, TypeReferenceProtoLike

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ObjectTypeDefinitionOrTypeReferenceProto

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ObjectTypeDefinitionProto(`type`: Option[String], properties: Map[String, PropertyDefinition], required: List[String], description: Option[String], isOverlay: Boolean) extends ObjectTypeDefinitionProtoLike

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ObjectTypeDefinitionProto

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait ObjectTypeDefinitionProtoLike

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
sealed trait PrimitiveType extends AnonymousType

A reference to a primitive type. A primitive type must have only the "type" property set.

A reference to a primitive type. A primitive type must have only the "type" property set.

Can be one of: StringType, IntegerType, NumberType, BooleanType

Attributes

See also
Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object BooleanType.type
object IntegerType.type
object NumberType.type
object StringType.type
object PrimitiveType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class PropertyDefinition(typeReference: TypeReference, const: Option[ConstValue], default: Option[ConstValue], defaultInfo: Option[DefaultInfo], deprecationMessage: Option[String], description: Option[String], replaceOnChanges: Boolean, willReplaceOnChanges: Boolean, secret: Boolean)

Describes an object or resource property

Describes an object or resource property

Value parameters

const

The constant value for the property, if any. The type of the value must be assignable to the type of the property.

default

The default value for the property, if any. The type of the value must be assignable to the type of the property.

defaultInfo

"Additional information about the property's default value, if any."

deprecationMessage

Indicates whether the property is deprecated

description

The description of the property, if any. Interpreted as Markdown.

replaceOnChanges

Specifies whether a change to the property causes its containing resource to be replaced instead of updated (default false).

secret

Specifies whether the property is secret (default false).

typeReference

A reference to a type that describes the property's type

willReplaceOnChanges

Indicates that the provider will replace the resource when this property is changed.

Attributes

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PropertyDefinition

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class PropertyDefinitionProto(`type`: Option[String], additionalProperties: Option[TypeReference], items: Option[TypeReference], oneOf: List[TypeReference], discriminator: Option[Discriminator], ref: Option[String], const: Option[ConstValue], default: Option[ConstValue], defaultInfo: Option[DefaultInfo], deprecationMessage: Option[String], description: Option[String], replaceOnChanges: Boolean, willReplaceOnChanges: Boolean, secret: Boolean) extends TypeReferenceProtoLike

Attributes

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PropertyDefinitionProto

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class PulumiPackage(name: String, version: Option[String], allowedPackageNames: List[String], meta: Meta, pluginDownloadURL: Option[String], types: Map[String, TypeDefinition], config: ConfigDefinition, provider: ResourceDefinition, resources: Map[String, ResourceDefinition], functions: Map[String, FunctionDefinition], language: Language)

PulumiPackage describes a Pulumi package.

PulumiPackage describes a Pulumi package.

Pulumi package metaschema:

Value parameters

config

The package's configuration variables

functions

A map from token to functionSpec that describes the set of functions defined by this package.

language

Additional language-specific data about the package

meta

Format metadata about this package

name

Name is the unqualified name of the package

pluginDownloadURL

The URL to use when downloading the provider plugin binary

provider

The provider type for this package, if any

resources

A map from type token to resourceSpec that describes the set of resources and components defined by this package.

types

A map from type token to complexTypeSpec that describes the set of complex types (i.e. object, enum) defined by this package.

version

Version is the version of the package

Attributes

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PulumiPackage

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ResourceDefinition(properties: Map[String, PropertyDefinition], required: List[String], deprecationMessage: Option[String], description: Option[String], inputProperties: Map[String, PropertyDefinition], stateInputs: ObjectTypeDefinition, aliases: List[AliasDefinition], isComponent: Boolean, isOverlay: Boolean, methods: Map[String, String], requiredInputs: List[String])

Describes a Pulumi resource or component.

Describes a Pulumi resource or component.

Value parameters

aliases

The list of aliases for the resource.

deprecationMessage

Indicates whether the resource is deprecated

description

The description of the resource, if any. Interpreted as Markdown.

inputProperties

A map from property name to propertySpec that describes the resource's input properties.

isComponent

Indicates whether the resource is a component.

isOverlay

Indicates that the implementation of the resource should not be generated from the schema, and is instead provided out-of-band by the package author

methods

A map from method name to function token that describes the resource's method set.

properties

A map from property name to propertySpec that describes the object's properties.

required

A list of the names of an object type's required properties. These properties must be set for inputs and will always be set for outputs.

requiredInputs

A list of the names of the resource's required input properties.

stateInputs

An optional objectTypeSpec that describes additional inputs that may be necessary to get an existing resource. If this is unset, only an ID is necessary.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourceDefinition

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ResourceIdType extends AnonymousType

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class StringConstValue(value: String) extends ConstValue

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ConstValue
class Object
trait Matchable
class Any
Show all
object StringType extends PrimitiveType

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
Self type
StringType.type
sealed trait TypeDefinition

Describes an object or enum type, a.k.a. a complex type (complexTypeSpec).

Describes an object or enum type, a.k.a. a complex type (complexTypeSpec).

Can be one of: EnumTypeDefinition or ObjectTypeDefinition

Value parameters

description

The description of the type, if any. Interpreted as Markdown.

isOverlay

Indicates that the implementation of the type should not be generated from the schema, and is instead provided out-of-band by the package author

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object TypeDefinition

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class TypeDefinitionProto(`type`: String, properties: Map[String, PropertyDefinition], required: List[String], enum: List[EnumValueDefinition], isOverlay: Boolean, description: Option[String])

Attributes

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TypeDefinitionProto

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait TypeReference

A reference to a type. The particular kind of type referenced is determined based on the contents of the "type" property and the presence or absence of the "additionalProperties", "items", "oneOf", and "ref" properties.

A reference to a type. The particular kind of type referenced is determined based on the contents of the "type" property and the presence or absence of the "additionalProperties", "items", "oneOf", and "ref" properties.

Attributes

See also
Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ArrayType
class MapType
object BooleanType.type
object IntegerType.type
object NumberType.type
object StringType.type
object ResourceIdType.type
class UnionType
object UrnType.type
class NamedType
Show all
object TypeReference

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class TypeReferenceProto(`type`: Option[String], additionalProperties: Option[TypeReference], items: Option[TypeReference], oneOf: List[TypeReference], discriminator: Option[Discriminator], ref: Option[String]) extends TypeReferenceProtoLike

Attributes

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TypeReferenceProto

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait TypeReferenceProtoLike extends AnonymousTypeProtoLike

Attributes

See also
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class UnionType(oneOf: List[TypeReference], `type`: Option[AnonymousType], discriminator: Option[Discriminator]) extends AnonymousType

A reference to a union type. The "oneOf" property must be present. The union may additional specify an underlying primitive type via the "type" property and a discriminator via the "discriminator" property. No other properties may be present.

A reference to a union type. The "oneOf" property must be present. The union may additional specify an underlying primitive type via the "type" property and a discriminator via the "discriminator" property. No other properties may be present.

Value parameters

`type`

The underlying primitive type of the union, if any

discriminator

Informs the consumer of an alternative schema based on the value associated with it

oneOf

If present, indicates that values of the type may be one of any of the listed types

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UrnType extends AnonymousType

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
UrnType.type
Generated with