alicloudroscdkcxapi

package module
v1.8.0 Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2025 License: Apache-2.0 Imports: 5 Imported by: 1

README

@alicloud/ros-cdk-cxapi

TODO: description

Usage

const rosCxapi = require('@alicloud/ros-cdk-cxapi');

// TODO: DEMONSTRATE API

Documentation

Overview

Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func EnvironmentPlaceholders_CURRENT_ACCOUNT 

func EnvironmentPlaceholders_CURRENT_ACCOUNT() *string

func EnvironmentPlaceholders_CURRENT_REGION 

func EnvironmentPlaceholders_CURRENT_REGION() *string

func EnvironmentPlaceholders_Replace 

func EnvironmentPlaceholders_Replace(object interface{}, values *EnvironmentPlaceholderValues) interface{}

Replace the environment placeholders in all strings found in a complex object.

func EnvironmentPlaceholders_ReplaceAsync 

func EnvironmentPlaceholders_ReplaceAsync(object interface{}, provider IEnvironmentPlaceholderProvider) interface{}

Like 'replace', but asynchronous.

func EnvironmentUtils_Format 

func EnvironmentUtils_Format(account *string, region *string) *string

Format an environment string from an account and region.

func NewCloudArtifact_Override 

func NewCloudArtifact_Override(c CloudArtifact, assembly CloudAssembly, id *string, manifest *alicloudroscdkassemblyschema.ArtifactManifest)

func NewCloudAssemblyBuilder_Override 

func NewCloudAssemblyBuilder_Override(c CloudAssemblyBuilder, outdir *string, props *CloudAssemblyBuilderProps)

Initializes a cloud assembly builder.

func NewCloudAssembly_Override 

func NewCloudAssembly_Override(c CloudAssembly, directory *string)

Reads a cloud assembly from the specified directory.

func NewEnvironmentPlaceholders_Override 

func NewEnvironmentPlaceholders_Override(e EnvironmentPlaceholders)

func NewEnvironmentUtils_Override 

func NewEnvironmentUtils_Override(e EnvironmentUtils)

func NewNestedCloudAssemblyArtifact_Override 

func NewNestedCloudAssemblyArtifact_Override(n NestedCloudAssemblyArtifact, assembly CloudAssembly, name *string, artifact *alicloudroscdkassemblyschema.ArtifactManifest)

func NewRosStackArtifact_Override 

func NewRosStackArtifact_Override(r RosStackArtifact, assembly CloudAssembly, artifactId *string, artifact *alicloudroscdkassemblyschema.ArtifactManifest)

func NewTreeCloudArtifact_Override 

func NewTreeCloudArtifact_Override(t TreeCloudArtifact, assembly CloudAssembly, name *string, artifact *alicloudroscdkassemblyschema.ArtifactManifest)

Types

type AliyunRosStackProperties 

type AliyunRosStackProperties struct {
	// A file relative to the assembly root which contains the ROS template for this stack.
	TemplateFile *string `field:"required" json:"templateFile" yaml:"templateFile"`
	// Values for ROS stack parameters that should be passed when the stack is deployed.
	Parameters *map[string]*string `field:"optional" json:"parameters" yaml:"parameters"`
	// The name to use for the ROS stack.
	StackName *string `field:"optional" json:"stackName" yaml:"stackName"`
}

Artifact properties for ROS stacks.

type AssemblyBuildOptions 

type AssemblyBuildOptions struct {
	// Include the specified runtime information (module versions) in manifest.
	RuntimeInfo *RuntimeInfo `field:"optional" json:"runtimeInfo" yaml:"runtimeInfo"`
}

type CloudArtifact 

type CloudArtifact interface {
	Assembly() CloudAssembly
	// Returns all the artifacts that this artifact depends on.
	Dependencies() *[]CloudArtifact
	Id() *string
	// The artifact's manifest.
	Manifest() *alicloudroscdkassemblyschema.ArtifactManifest
	// The set of messages extracted from the artifact's metadata.
	Messages() *[]*SynthesisMessage
	// Returns: all the metadata entries of a specific type in this artifact.
	FindMetadataByType(type_ *string) *[]*MetadataEntryResult
}

Represents an artifact within a cloud assembly.

func CloudArtifact_FromManifest 

func CloudArtifact_FromManifest(assembly CloudAssembly, id *string, artifact *alicloudroscdkassemblyschema.ArtifactManifest) CloudArtifact

Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.

Returns: the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.

func NestedCloudAssemblyArtifact_FromManifest 

func NestedCloudAssemblyArtifact_FromManifest(assembly CloudAssembly, id *string, artifact *alicloudroscdkassemblyschema.ArtifactManifest) CloudArtifact

Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.

Returns: the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.

func NewCloudArtifact 

func NewCloudArtifact(assembly CloudAssembly, id *string, manifest *alicloudroscdkassemblyschema.ArtifactManifest) CloudArtifact

func RosStackArtifact_FromManifest 

func RosStackArtifact_FromManifest(assembly CloudAssembly, id *string, artifact *alicloudroscdkassemblyschema.ArtifactManifest) CloudArtifact

Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.

Returns: the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.

func TreeCloudArtifact_FromManifest 

func TreeCloudArtifact_FromManifest(assembly CloudAssembly, id *string, artifact *alicloudroscdkassemblyschema.ArtifactManifest) CloudArtifact

Returns a subclass of `CloudArtifact` based on the artifact type defined in the artifact manifest.

Returns: the `CloudArtifact` that matches the artifact type or `undefined` if it's an artifact type that is unrecognized by this module.

type CloudAssembly 

type CloudAssembly interface {
	// All artifacts included in this assembly.
	Artifacts() *[]CloudArtifact
	// The root directory of the cloud assembly.
	Directory() *string
	// The raw assembly manifest.
	Manifest() *alicloudroscdkassemblyschema.AssemblyManifest
	// Runtime information such as module versions used to synthesize this assembly.
	Runtime() *alicloudroscdkassemblyschema.RuntimeInfo
	// Returns: all the ROS stack artifacts that are included in this assembly.
	Stacks() *[]RosStackArtifact
	// The schema version of the assembly manifest.
	Version() *string
	// Returns a nested assembly.
	GetNestedAssembly(artifactId *string) CloudAssembly
	// Returns a nested assembly artifact.
	GetNestedAssemblyArtifact(artifactId *string) NestedCloudAssemblyArtifact
	// Returns a ROS stack artifact by name from this assembly.
	//
	// Deprecated renamed to 'getStackByName' (or 'getStackArtifact(id)').
	GetStack(stackName *string) RosStackArtifact
	// Returns a ROS stack artifact from this assembly.
	//
	// Param artifactId the artifact id of the stack (can be obtained through 'stack.artifactId').
	// Throws if there is no stack artifact with that id
	// Returns a 'RosStackArtifact' object.
	GetStackArtifact(artifactId *string) RosStackArtifact
	// Returns a ROS stack artifact from this assembly.
	//
	// Will only search the current assembly.
	//
	// Param stackName the name of the ROS stack.
	// Throws if there is no stack artifact by that name
	// Throws if there is more than one stack with the same stack name. You can
	// use 'getStackArtifact - stack.artifactId' instead.
	// Returns a 'RosStackArtifact' object.
	GetStackByName(stackName *string) RosStackArtifact
	// Returns the tree metadata artifact from this assembly.
	//
	// Throws if there is no metadata artifact by that name
	// Returns a 'TreeCloudArtifact' object if there is one defined in the manifest, 'undefined' otherwise.
	Tree() TreeCloudArtifact
	// Attempts to find an artifact with a specific identity.
	//
	// Returns A 'CloudArtifact' object or 'undefined' if the artifact does not exist in this assembly.
	// Param id The artifact ID.
	TryGetArtifact(id *string) CloudArtifact
}

Represents a deployable cloud application.

func NewCloudAssembly 

func NewCloudAssembly(directory *string) CloudAssembly

Reads a cloud assembly from the specified directory.

type CloudAssemblyBuilder 

type CloudAssemblyBuilder interface {
	// The directory where assets of this Cloud Assembly should be stored.
	AssetOutdir() *string
	// The root directory of the resulting cloud assembly.
	Outdir() *string
	// Adds an artifact into the cloud assembly.
	AddArtifact(id *string, manifest *alicloudroscdkassemblyschema.ArtifactManifest)
	// Reports that some context is missing in order for this cloud assembly to be fully synthesized.
	AddMissing(missing *alicloudroscdkassemblyschema.MissingContext)
	// Finalizes the cloud assembly into the output directory returns a 'CloudAssembly' object that can be used to inspect the assembly.
	BuildAssembly(options *AssemblyBuildOptions) CloudAssembly
	// Creates a nested cloud assembly.
	CreateNestedAssembly(artifactId *string, displayName *string) CloudAssemblyBuilder
}

Can be used to build a cloud assembly.

func NewCloudAssemblyBuilder 

func NewCloudAssemblyBuilder(outdir *string, props *CloudAssemblyBuilderProps) CloudAssemblyBuilder

Initializes a cloud assembly builder.

type CloudAssemblyBuilderProps 

type CloudAssemblyBuilderProps struct {
	// Use the given asset output directory.
	AssetOutdir *string `field:"optional" json:"assetOutdir" yaml:"assetOutdir"`
	// If this builder is for a nested assembly, the parent assembly builder.
	ParentBuilder CloudAssemblyBuilder `field:"optional" json:"parentBuilder" yaml:"parentBuilder"`
}

Construction properties for CloudAssemblyBuilder.

type Environment 

type Environment struct {
	// The ALIYUN account this environment deploys into.
	Account *string `field:"required" json:"account" yaml:"account"`
	// The arbitrary name of this environment (user-set, or at least user-meaningful).
	Name *string `field:"required" json:"name" yaml:"name"`
	// The ALIYUN region name where this environment deploys into.
	Region *string `field:"required" json:"region" yaml:"region"`
}

Models an ALIYUN execution environment, for use within the CDK toolkit.

func EnvironmentUtils_Make 

func EnvironmentUtils_Make(account *string, region *string) *Environment

Build an environment object from an account and region.

func EnvironmentUtils_Parse 

func EnvironmentUtils_Parse(environment *string) *Environment

type EnvironmentPlaceholderValues 

type EnvironmentPlaceholderValues struct {
	// Return the account.
	AccountId *string `field:"required" json:"accountId" yaml:"accountId"`
	// Return the region.
	Region *string `field:"required" json:"region" yaml:"region"`
}

Return the appropriate values for the environment placeholders.

type EnvironmentPlaceholders 

type EnvironmentPlaceholders interface {
}

Placeholders which can be used manifests.

These can occur both in the Asset Manifest as well as the general Cloud Assembly manifest.

func NewEnvironmentPlaceholders 

func NewEnvironmentPlaceholders() EnvironmentPlaceholders

type EnvironmentUtils 

type EnvironmentUtils interface {
}

func NewEnvironmentUtils 

func NewEnvironmentUtils() EnvironmentUtils

type IEnvironmentPlaceholderProvider 

type IEnvironmentPlaceholderProvider interface {
	// Return the account.
	AccountId() *string
	// Return the region.
	Region() *string
}

Return the appropriate values for the environment placeholders.

type MetadataEntry deprecated 

type MetadataEntry struct {
	// The type of the metadata entry.
	// Deprecated: moved to package 'ros-assembly-schema'.
	Type *string `field:"required" json:"type" yaml:"type"`
	// The data.
	// Deprecated: moved to package 'ros-assembly-schema'.
	Data interface{} `field:"optional" json:"data" yaml:"data"`
	// A stack trace for when the entry was created.
	// Deprecated: moved to package 'ros-assembly-schema'.
	Trace *[]*string `field:"optional" json:"trace" yaml:"trace"`
}

Backwards compatibility for when 'MetadataEntry' was defined here.

This is necessary because its used as an input in the stable. See: core.ConstructNode.metadata

Deprecated: moved to package 'ros-assembly-schema'.

type MetadataEntryResult 

type MetadataEntryResult struct {
	// The type of the metadata entry.
	Type *string `field:"required" json:"type" yaml:"type"`
	// The data.
	Data interface{} `field:"optional" json:"data" yaml:"data"`
	// A stack trace for when the entry was created.
	Trace *[]*string `field:"optional" json:"trace" yaml:"trace"`
	// The path in which this entry was defined.
	Path *string `field:"required" json:"path" yaml:"path"`
}

type MissingContext deprecated 

type MissingContext struct {
	// The missing context key.
	// Deprecated: moved to package 'ros-assembly-schema'.
	Key *string `field:"required" json:"key" yaml:"key"`
	// A set of provider-specific options.
	//
	// (This is the old untyped definition, which is necessary for backwards compatibility.
	// See cxschema for a type definition.)
	// Deprecated: moved to package 'ros-assembly-schema'.
	Props *map[string]interface{} `field:"required" json:"props" yaml:"props"`
	// The provider from which we expect this context key to be obtained.
	//
	// (This is the old untyped definition, which is necessary for backwards compatibility.
	// See cxschema for a type definition.)
	// Deprecated: moved to package 'ros-assembly-schema'.
	Provider *string `field:"required" json:"provider" yaml:"provider"`
}

Backwards compatibility for when 'MissingContext' was defined here.

This is necessary because its used as an input in the stable. See: core.Stack.reportMissingContext

Deprecated: moved to package 'ros-assembly-schema'.

type NestedCloudAssemblyArtifact 

type NestedCloudAssemblyArtifact interface {
	CloudArtifact
	Assembly() CloudAssembly
	// Returns all the artifacts that this artifact depends on.
	Dependencies() *[]CloudArtifact
	// The relative directory name of the asset manifest.
	DirectoryName() *string
	// Display name.
	DisplayName() *string
	// Full path to the nested assembly directory.
	FullPath() *string
	Id() *string
	// The artifact's manifest.
	Manifest() *alicloudroscdkassemblyschema.ArtifactManifest
	// The set of messages extracted from the artifact's metadata.
	Messages() *[]*SynthesisMessage
	// The nested Assembly.
	NestedAssembly() CloudAssembly
	// Returns: all the metadata entries of a specific type in this artifact.
	FindMetadataByType(type_ *string) *[]*MetadataEntryResult
}

Asset manifest is a description of a set of assets which need to be built and published.

func NewNestedCloudAssemblyArtifact 

func NewNestedCloudAssemblyArtifact(assembly CloudAssembly, name *string, artifact *alicloudroscdkassemblyschema.ArtifactManifest) NestedCloudAssemblyArtifact

type RosStackArtifact 

type RosStackArtifact interface {
	CloudArtifact
	Assembly() CloudAssembly
	// Returns all the artifacts that this artifact depends on.
	Dependencies() *[]CloudArtifact
	// A string that represents this stack.
	//
	// Should only be used in user interfaces.
	// If the stackName and artifactId are the same, it will just return that. Otherwise,
	// it will return something like "<artifactId> (<stackName>)".
	DisplayName() *string
	Id() *string
	// The artifact's manifest.
	Manifest() *alicloudroscdkassemblyschema.ArtifactManifest
	// The set of messages extracted from the artifact's metadata.
	Messages() *[]*SynthesisMessage
	// The physical name of this stack.
	// Deprecated: renamed to `stackName`.
	Name() *string
	// The original name as defined in the CDK app.
	OriginalName() *string
	// ROS parameters to pass to the stack.
	Parameters() *map[string]*string
	// The physical name of this stack.
	StackName() *string
	Tags() interface{}
	// The ROS template for this stack.
	Template() interface{}
	// The file name of the template.
	TemplateFile() *string
	// Returns: all the metadata entries of a specific type in this artifact.
	FindMetadataByType(type_ *string) *[]*MetadataEntryResult
}

func NewRosStackArtifact 

func NewRosStackArtifact(assembly CloudAssembly, artifactId *string, artifact *alicloudroscdkassemblyschema.ArtifactManifest) RosStackArtifact

type RuntimeInfo deprecated 

type RuntimeInfo struct {
	// The list of libraries loaded in the application, associated with their versions.
	// Deprecated: moved to package 'ros-assembly-schema'.
	Libraries *map[string]*string `field:"required" json:"libraries" yaml:"libraries"`
}

Backwards compatibility for when 'RuntimeInfo' was defined here.

This is necessary because its used as an input in the stable. See: core.ConstructNode.synth

Deprecated: moved to package 'ros-assembly-schema'.

type SynthesisMessage 

type SynthesisMessage struct {
	Entry *alicloudroscdkassemblyschema.MetadataEntry `field:"required" json:"entry" yaml:"entry"`
	Id    *string                                     `field:"required" json:"id" yaml:"id"`
	Level SynthesisMessageLevel                       `field:"required" json:"level" yaml:"level"`
}

type SynthesisMessageLevel 

type SynthesisMessageLevel string
const (
	SynthesisMessageLevel_INFO    SynthesisMessageLevel = "INFO"
	SynthesisMessageLevel_WARNING SynthesisMessageLevel = "WARNING"
	SynthesisMessageLevel_ERROR   SynthesisMessageLevel = "ERROR"
)

type TreeCloudArtifact 

type TreeCloudArtifact interface {
	CloudArtifact
	Assembly() CloudAssembly
	// Returns all the artifacts that this artifact depends on.
	Dependencies() *[]CloudArtifact
	File() *string
	Id() *string
	// The artifact's manifest.
	Manifest() *alicloudroscdkassemblyschema.ArtifactManifest
	// The set of messages extracted from the artifact's metadata.
	Messages() *[]*SynthesisMessage
	// Returns: all the metadata entries of a specific type in this artifact.
	FindMetadataByType(type_ *string) *[]*MetadataEntryResult
}

func NewTreeCloudArtifact 

func NewTreeCloudArtifact(assembly CloudAssembly, name *string, artifact *alicloudroscdkassemblyschema.ArtifactManifest) TreeCloudArtifact

Source Files

View all Source files

Directories

Path Synopsis
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
 Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

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.