dotnet

package
v3.120.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 13, 2024 License: Apache-2.0 Imports: 40 Imported by: 68

Documentation

Overview

Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.

Index

Constants

This section is empty.

Variables

View Source 
var Importer schema.Language = importer(0)

Importer implements schema.Language for .NET.

Functions

func AnnotateComponentInputs added in v3.60.0 

func AnnotateComponentInputs(component *pcl.Component)

func Check added in v3.27.0 

func Check(t *testing.T, path string, dependencies codegen.StringSet, pulumiSDKPath string)

func GeneratePackage 

func GeneratePackage(
	tool string, pkg *schema.Package, extraFiles map[string][]byte, localDependencies map[string]string,
) (map[string][]byte, error)

func GenerateProgram 

func GenerateProgram(program *pcl.Program) (map[string][]byte, hcl.Diagnostics, error)

func GenerateProgramBatchTest added in v3.44.0 

func GenerateProgramBatchTest(t *testing.T, testCases []test.ProgramTest)

func GenerateProgramWithOptions added in v3.37.0 

func GenerateProgramWithOptions(
	program *pcl.Program,
	options GenerateProgramOptions,
) (map[string][]byte, hcl.Diagnostics, error)

func GenerateProject added in v3.31.0 

func GenerateProject(
	directory string, project workspace.Project,
	program *pcl.Program, localDependencies map[string]string,
) error

func LanguageResources 

func LanguageResources(tool string, pkg *schema.Package) (map[string]LanguageResource, error)

LanguageResources returns a map of resources that can be used by downstream codegen. The map key is the resource schema token.

func LowerCamelCase added in v3.37.0 

func LowerCamelCase(s string) string

LowerCamelCase sets the first character to lowercase LowerCamelCase("LowerCamelCase") -> "lowerCamelCase"

func Title 

func Title(s string) string

Title converts the input string to a title case where only the initial letter is upper-cased.

func TypeCheck added in v3.33.2 

func TypeCheck(t *testing.T, path string, dependencies codegen.StringSet, pulumiSDKPath string)

Types

type CSharpPackageInfo 

type CSharpPackageInfo struct {
	PackageReferences      map[string]string `json:"packageReferences,omitempty"`
	Namespaces             map[string]string `json:"namespaces,omitempty"`
	Compatibility          string            `json:"compatibility,omitempty"`
	DictionaryConstructors bool              `json:"dictionaryConstructors,omitempty"`
	ProjectReferences      []string          `json:"projectReferences,omitempty"`
	// Determines whether to make single-return-value methods return an output object or the single value.
	LiftSingleValueMethodReturns bool `json:"liftSingleValueMethodReturns,omitempty"`

	// The root namespace used for the package. This defaults to `Pulumi`.
	RootNamespace string `json:"rootNamespace,omitempty"`

	// Allow the Pkg.Version field to filter down to emitted code.
	RespectSchemaVersion bool `json:"respectSchemaVersion,omitempty"`
}

CSharpPackageInfo represents the C# language-specific info for a package.

func (*CSharpPackageInfo) GetRootNamespace added in v3.23.0 

func (info *CSharpPackageInfo) GetRootNamespace() string

Returns the root namespace, or "Pulumi" if not provided.

type CSharpPropertyInfo 

type CSharpPropertyInfo struct {
	Name string `json:"name,omitempty"`
}

CSharpPropertyInfo represents the C# language-specific info for a property.

type CSharpResourceInfo added in v3.95.0 

type CSharpResourceInfo struct {
	Name string `json:"name,omitempty"`
}

CSharpResourceInfo represents the C# language-specific info for a resource.

type DocLanguageHelper 

type DocLanguageHelper struct {
	// Namespaces is a map of Pulumi schema module names to their
	// C# equivalent names, to be used when creating fully-qualified
	// property type strings.
	Namespaces map[string]string
}

DocLanguageHelper is the DotNet-specific implementation of the DocLanguageHelper.

func (DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType 

func (d DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string

GetDocLinkForFunctionInputOrOutputType returns the doc link for an input or output type of a Function.

func (DocLanguageHelper) GetDocLinkForPulumiType 

func (d DocLanguageHelper) GetDocLinkForPulumiType(pkg *schema.Package, typeName string) string

GetDocLinkForPulumiType returns the .Net API doc link for a Pulumi type.

func (DocLanguageHelper) GetDocLinkForResourceInputOrOutputType 

func (d DocLanguageHelper) GetDocLinkForResourceInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string

GetDocLinkForResourceInputOrOutputType returns the doc link for an input or output type of a Resource.

func (DocLanguageHelper) GetDocLinkForResourceType 

func (d DocLanguageHelper) GetDocLinkForResourceType(pkg *schema.Package, _, typeName string) string

GetDocLinkForResourceType returns the .NET API doc URL for a type belonging to a resource provider.

func (DocLanguageHelper) GetEnumName 

func (d DocLanguageHelper) GetEnumName(e *schema.Enum, typeName string) (string, error)

GetEnumName returns the enum name specific to C#.

func (DocLanguageHelper) GetFunctionName 

func (d DocLanguageHelper) GetFunctionName(modName string, f *schema.Function) string

func (DocLanguageHelper) GetLanguageTypeString 

func (d DocLanguageHelper) GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input bool) string

GetLanguageTypeString returns the DotNet-specific type given a Pulumi schema type.

func (DocLanguageHelper) GetMethodName added in v3.10.2 

func (d DocLanguageHelper) GetMethodName(m *schema.Method) string

func (DocLanguageHelper) GetMethodResultName added in v3.10.2 

func (d DocLanguageHelper) GetMethodResultName(pkg *schema.Package, modName string, r *schema.Resource,
	m *schema.Method,
) string
func (d DocLanguageHelper) GetModuleDocLink(pkg *schema.Package, modName string) (string, string)

GetModuleDocLink returns the display name and the link for a module.

func (DocLanguageHelper) GetPropertyName 

func (d DocLanguageHelper) GetPropertyName(p *schema.Property) (string, error)

GetPropertyName uses the property's csharp-specific language info, if available, to generate the property name. Otherwise, returns the PascalCase as the default.

func (DocLanguageHelper) GetResourceFunctionResultName 

func (d DocLanguageHelper) GetResourceFunctionResultName(modName string, f *schema.Function) string

GetResourceFunctionResultName returns the name of the result type when a function is used to lookup an existing resource.

type GenerateProgramOptions added in v3.37.0 

type GenerateProgramOptions struct {
	// contains filtered or unexported fields
}

type LanguageResource 

type LanguageResource struct {
	*schema.Resource

	Name    string // The resource name (e.g. Deployment)
	Package string // The package name (e.g. Apps.V1)
}

LanguageResource is derived from the schema and can be used by downstream codegen.

type ObjectTypeFromConfigMetadata added in v3.60.0 

type ObjectTypeFromConfigMetadata = struct {
	TypeName      string
	ComponentName string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.