root
API
Generated with
root/pulumirpc/pulumirpc.language

pulumirpc.language

package pulumirpc.language

Members list

Type members

Classlikes

final case class AboutRequest(info: Option[ProgramInfo], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[AboutRequest]

Value parameters

info

the program info to use.

Attributes

Companion
object
Supertypes
trait Updatable[AboutRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AboutRequest extends GeneratedMessageCompanion[AboutRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[AboutRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class AboutResponse(executable: String, version: String, metadata: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[AboutResponse]

AboutResponse returns runtime information about the language.

AboutResponse returns runtime information about the language.

Value parameters

executable

the primary executable for the runtime of this language.

metadata

other information about this language.

version

the version of the runtime for this language.

Attributes

Companion
object
Supertypes
trait Updatable[AboutResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AboutResponse extends GeneratedMessageCompanion[AboutResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[AboutResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class DependencyInfo(name: String, version: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DependencyInfo]

Value parameters

name

The name of the dependency.

version

The version of the dependency.

Attributes

Companion
object
Supertypes
trait Updatable[DependencyInfo]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DependencyInfo extends GeneratedMessageCompanion[DependencyInfo]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DependencyInfo]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GeneratePackageRequest(directory: String, schema: String, extraFiles: Map[String, ByteString], loaderTarget: String, localDependencies: Map[String, String], local: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GeneratePackageRequest]

Value parameters

directory

the directory to generate the package in.

extraFiles

extra files to copy to the package output.

loaderTarget

The target of a codegen.LoaderServer to use for loading schemas.

local

if true generates an SDK appropriate for local usage, this may differ from a standard publishable SDK depending on the language.

localDependencies

local dependencies to use instead of using the package system. This is a map of package name to a local path of a language specific artifact to use for the SDK for that package.

schema

the JSON-encoded schema.

Attributes

Companion
object
Supertypes
trait Updatable[GeneratePackageRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GeneratePackageRequest extends GeneratedMessageCompanion[GeneratePackageRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GeneratePackageRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GeneratePackageResponse(diagnostics: Seq[Diagnostic], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GeneratePackageResponse]

Value parameters

diagnostics

any diagnostics from code generation.

Attributes

Companion
object
Supertypes
trait Updatable[GeneratePackageResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GeneratePackageResponse extends GeneratedMessageCompanion[GeneratePackageResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GeneratePackageResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GenerateProgramRequest(source: Map[String, String], loaderTarget: String, strict: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GenerateProgramRequest]

Value parameters

loaderTarget

The target of a codegen.LoaderServer to use for loading schemas.

source

the PCL source of the project.

strict

if PCL binding should be strict or not.

Attributes

Companion
object
Supertypes
trait Updatable[GenerateProgramRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GenerateProgramRequest extends GeneratedMessageCompanion[GenerateProgramRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GenerateProgramRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GenerateProgramResponse(diagnostics: Seq[Diagnostic], source: Map[String, ByteString], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GenerateProgramResponse]

Value parameters

diagnostics

any diagnostics from code generation.

source

the generated program source code.

Attributes

Companion
object
Supertypes
trait Updatable[GenerateProgramResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GenerateProgramResponse extends GeneratedMessageCompanion[GenerateProgramResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GenerateProgramResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GenerateProjectRequest(sourceDirectory: String, targetDirectory: String, project: String, strict: Boolean, loaderTarget: String, localDependencies: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GenerateProjectRequest]

Value parameters

loaderTarget

The target of a codegen.LoaderServer to use for loading schemas.

localDependencies

local dependencies to use instead of using the package system. This is a map of package name to a local path of a language specific artifact to use for the SDK for that package.

project

the JSON-encoded pulumi project file.

sourceDirectory

the directory to generate the project from.

strict

if PCL binding should be strict or not.

targetDirectory

the directory to generate the project in.

Attributes

Companion
object
Supertypes
trait Updatable[GenerateProjectRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GenerateProjectRequest extends GeneratedMessageCompanion[GenerateProjectRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GenerateProjectRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GenerateProjectResponse(diagnostics: Seq[Diagnostic], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GenerateProjectResponse]

Value parameters

diagnostics

any diagnostics from code generation.

Attributes

Companion
object
Supertypes
trait Updatable[GenerateProjectResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GenerateProjectResponse extends GeneratedMessageCompanion[GenerateProjectResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GenerateProjectResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetProgramDependenciesRequest(project: String, pwd: String, program: String, transitiveDependencies: Boolean, info: Option[ProgramInfo], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetProgramDependenciesRequest]

Value parameters

info

the program info to use to calculate dependencies.

program

the path to the program. Deprecated, use info.entry_point instead.

project

the project name, the engine always sets this to "deprecated" now.

pwd

the program's working directory. Deprecated, use info.program_directory instead.

transitiveDependencies

if transitive dependencies should be included in the result.

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetProgramDependenciesRequest extends GeneratedMessageCompanion[GetProgramDependenciesRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetProgramDependenciesRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetProgramDependenciesResponse(dependencies: Seq[DependencyInfo], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetProgramDependenciesResponse]

Value parameters

dependencies

the dependencies of this program

Attributes

Companion
object
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetProgramDependenciesResponse extends GeneratedMessageCompanion[GetProgramDependenciesResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetProgramDependenciesResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetRequiredPluginsRequest(project: String, pwd: String, program: String, info: Option[ProgramInfo], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetRequiredPluginsRequest]

Value parameters

info

the program info to use to calculate plugins.

program

the path to the program. Deprecated, use info.entry_point instead.

project

the project name, the engine always sets this to "deprecated" now.

pwd

the program's working directory. Deprecated, use info.program_directory instead.

Attributes

Companion
object
Supertypes
trait Updatable[GetRequiredPluginsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetRequiredPluginsRequest extends GeneratedMessageCompanion[GetRequiredPluginsRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetRequiredPluginsRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetRequiredPluginsResponse(plugins: Seq[PluginDependency], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetRequiredPluginsResponse]

Value parameters

plugins

a list of plugins required by this program.

Attributes

Companion
object
Supertypes
trait Updatable[GetRequiredPluginsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetRequiredPluginsResponse extends GeneratedMessageCompanion[GetRequiredPluginsResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetRequiredPluginsResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class InstallDependenciesRequest(directory: String, isTerminal: Boolean, info: Option[ProgramInfo], useLanguageVersionTools: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[InstallDependenciesRequest]

Value parameters

directory

the program's working directory. Deprecated, use info.program_directory instead.

info

the program info to use to execute the plugin.

isTerminal

if we are running in a terminal and should use ANSI codes

useLanguageVersionTools

if we should use language version tools like pyenv or

Attributes

Companion
object
Supertypes
trait Updatable[InstallDependenciesRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object InstallDependenciesRequest extends GeneratedMessageCompanion[InstallDependenciesRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[InstallDependenciesRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class InstallDependenciesResponse(stdout: ByteString, stderr: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[InstallDependenciesResponse]

Value parameters

stderr

a line of stderr text.

stdout

a line of stdout text.

Attributes

Companion
object
Supertypes
trait Updatable[InstallDependenciesResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object InstallDependenciesResponse extends GeneratedMessageCompanion[InstallDependenciesResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[InstallDependenciesResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object LanguageProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
object LanguageRuntimeGrpc

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class PackRequest(packageDirectory: String, destinationDirectory: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[PackRequest]

Value parameters

destinationDirectory

the directory to write the packed artifact to.

packageDirectory

the directory of a package to pack.

Attributes

Companion
object
Supertypes
trait Updatable[PackRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PackRequest extends GeneratedMessageCompanion[PackRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[PackRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class PackResponse(artifactPath: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[PackResponse]

Value parameters

artifactPath

the full path of the packed artifact.

Attributes

Companion
object
Supertypes
trait Updatable[PackResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PackResponse extends GeneratedMessageCompanion[PackResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[PackResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ProgramInfo(rootDirectory: String, programDirectory: String, entryPoint: String, options: Option[Struct], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ProgramInfo]

ProgramInfo are the common set of options that a language runtime needs to execute or query a program. This is filled in by the engine based on where the Pulumi.yaml file was, the runtime.options property, and the main property.

ProgramInfo are the common set of options that a language runtime needs to execute or query a program. This is filled in by the engine based on where the Pulumi.yaml file was, the runtime.options property, and the main property.

Value parameters

entryPoint

the entry point of the program, normally '.' meaning to just use the program directory, but can also be a filename inside the program directory. How that filename is interpreted, if at all, is language specific.

options

JSON style options from the Pulumi.yaml runtime options section.

programDirectory

the absolute path to the directory of the program to execute. Generally, but not required to be, underneath the root directory.

rootDirectory

the root of the project, where the Pulumi.yaml file is located.

Attributes

Companion
object
Supertypes
trait Updatable[ProgramInfo]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ProgramInfo extends GeneratedMessageCompanion[ProgramInfo]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ProgramInfo]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RunPluginRequest(pwd: String, program: String, args: Seq[String], env: Seq[String], info: Option[ProgramInfo], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RunPluginRequest]

Value parameters

args

any arguments to pass to the program.

env

any environment variables to set as part of the program.

info

the program info to use to execute the plugin.

program

the path to the program to execute. Deprecated, use info.entry_point instead.

pwd

the program's working directory.

Attributes

Companion
object
Supertypes
trait Updatable[RunPluginRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RunPluginRequest extends GeneratedMessageCompanion[RunPluginRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RunPluginRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RunPluginResponse(output: Output, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RunPluginResponse]

Attributes

Companion
object
Supertypes
trait Updatable[RunPluginResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RunPluginResponse extends GeneratedMessageCompanion[RunPluginResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RunPluginResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RunRequest(project: String, stack: String, pwd: String, program: String, args: Seq[String], config: Map[String, String], dryRun: Boolean, parallel: Int, monitorAddress: String, queryMode: Boolean, configSecretKeys: Seq[String], organization: String, configPropertyMap: Option[Struct], info: Option[ProgramInfo], loaderTarget: String, attachDebugger: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RunRequest]

RunRequest asks the interpreter to execute a program.

RunRequest asks the interpreter to execute a program.

Value parameters

args

any arguments to pass to the program.

attachDebugger

true if the language host is supposed to start the program under a debugger.

config

the configuration variables to apply before running.

configPropertyMap

the configuration variables to apply before running.

configSecretKeys

the configuration keys that have secret values.

dryRun

true if we're only doing a dryrun (preview).

info

the program info to use to execute the program.

loaderTarget

The target of a codegen.LoaderServer to use for loading schemas.

monitorAddress

the address for communicating back to the resource monitor.

organization

the organization of the stack being deployed into.

parallel

the degree of parallelism for resource operations (<=1 for serial).

program

the path to the program to execute. Deprecated, use info.entry_point instead.

project

the project name.

pwd

the program's working directory.

queryMode

true if we're only doing a query.

stack

the name of the stack being deployed into.

Attributes

Companion
object
Supertypes
trait Updatable[RunRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RunRequest extends GeneratedMessageCompanion[RunRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RunRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
RunRequest.type
final case class RunResponse(error: String, bail: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RunResponse]

RunResponse is the response back from the interpreter/source back to the monitor.

RunResponse is the response back from the interpreter/source back to the monitor.

Value parameters

bail

An error happened. And it was reported to the user. Work should stop immediately with nothing further to print to the user. This corresponds to a "result.Bail()" value in the 'go' layer.

error

An unhandled error if any occurred.

Attributes

Companion
object
Supertypes
trait Updatable[RunResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RunResponse extends GeneratedMessageCompanion[RunResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RunResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RuntimeOptionPrompt(key: String, description: String, promptType: RuntimeOptionType, choices: Seq[RuntimeOptionValue], default: Option[RuntimeOptionValue], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RuntimeOptionPrompt]

Attributes

Companion
object
Supertypes
trait Updatable[RuntimeOptionPrompt]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RuntimeOptionPrompt extends GeneratedMessageCompanion[RuntimeOptionPrompt]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RuntimeOptionPrompt]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RuntimeOptionsRequest(info: Option[ProgramInfo], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RuntimeOptionsRequest]

Value parameters

info

The current program info used to evaluate which prompts should be asked.

Attributes

Companion
object
Supertypes
trait Updatable[RuntimeOptionsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RuntimeOptionsRequest extends GeneratedMessageCompanion[RuntimeOptionsRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RuntimeOptionsRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RuntimeOptionsResponse(prompts: Seq[RuntimeOptionPrompt], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RuntimeOptionsResponse]

Value parameters

prompts

additional prompts to ask the user

Attributes

Companion
object
Supertypes
trait Updatable[RuntimeOptionsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RuntimeOptionsResponse extends GeneratedMessageCompanion[RuntimeOptionsResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RuntimeOptionsResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Generated with