pulumi/sdk/nodejs/proto/resource_pb.d.ts

771 lines
34 KiB
TypeScript
Raw Permalink Normal View History

// package: pulumirpc
// file: pulumi/resource.proto
/* tslint:disable */
/* eslint-disable */
import * as jspb from "google-protobuf";
import * as google_protobuf_empty_pb from "google-protobuf/google/protobuf/empty_pb";
import * as google_protobuf_struct_pb from "google-protobuf/google/protobuf/struct_pb";
import * as pulumi_provider_pb from "./provider_pb";
import * as pulumi_alias_pb from "./alias_pb";
import * as pulumi_source_pb from "./source_pb";
Engine support for remote transforms (#15290) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> This adds support to the engine for "remote transformations". A transform is "remote" because it is being invoked via the engine on receiving a resource registration, rather than being ran locally in process before sending a resource registration. These transforms can also span multiple process boundaries, e.g. a transform function in a user program, then a transform function in a component library, both running for a resource registered by another component library. The underlying new feature here is the idea of a `Callback`. The expectation is we're going to use callbacks for multiple features so these are _not_ defined in terms of transformations. A callback is an untyped byte array (usually will be a protobuf message), plus an address to define which server should be invoked to do the callback, and a token to identify it. A language sdk can start up and serve a `Callbacks` service, keep a mapping of tokens to in-process functions (currently just using UUID's for this), and then pass that service address and token to the engine to be invoked later on. The engine uses these callbacks to track transformations callbacks per resource, and on a new resource registrations invokes each relevant callback with the resource properties and options, having new properties and options returned that are then passed to the next relevant transform callback until all have been called and the engine has the final resource state and options to use. ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2024-02-21 16:30:46 +00:00
import * as pulumi_callback_pb from "./callback_pb";
export class SupportsFeatureRequest extends jspb.Message {
getId(): string;
setId(value: string): SupportsFeatureRequest;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): SupportsFeatureRequest.AsObject;
static toObject(includeInstance: boolean, msg: SupportsFeatureRequest): SupportsFeatureRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: SupportsFeatureRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): SupportsFeatureRequest;
static deserializeBinaryFromReader(message: SupportsFeatureRequest, reader: jspb.BinaryReader): SupportsFeatureRequest;
}
export namespace SupportsFeatureRequest {
export type AsObject = {
id: string,
}
}
export class SupportsFeatureResponse extends jspb.Message {
getHassupport(): boolean;
setHassupport(value: boolean): SupportsFeatureResponse;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): SupportsFeatureResponse.AsObject;
static toObject(includeInstance: boolean, msg: SupportsFeatureResponse): SupportsFeatureResponse.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: SupportsFeatureResponse, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): SupportsFeatureResponse;
static deserializeBinaryFromReader(message: SupportsFeatureResponse, reader: jspb.BinaryReader): SupportsFeatureResponse;
}
export namespace SupportsFeatureResponse {
export type AsObject = {
hassupport: boolean,
}
}
export class ReadResourceRequest extends jspb.Message {
getId(): string;
setId(value: string): ReadResourceRequest;
getType(): string;
setType(value: string): ReadResourceRequest;
getName(): string;
setName(value: string): ReadResourceRequest;
getParent(): string;
setParent(value: string): ReadResourceRequest;
hasProperties(): boolean;
clearProperties(): void;
getProperties(): google_protobuf_struct_pb.Struct | undefined;
setProperties(value?: google_protobuf_struct_pb.Struct): ReadResourceRequest;
clearDependenciesList(): void;
getDependenciesList(): Array<string>;
setDependenciesList(value: Array<string>): ReadResourceRequest;
addDependencies(value: string, index?: number): string;
getProvider(): string;
setProvider(value: string): ReadResourceRequest;
getVersion(): string;
setVersion(value: string): ReadResourceRequest;
getAcceptsecrets(): boolean;
setAcceptsecrets(value: boolean): ReadResourceRequest;
clearAdditionalsecretoutputsList(): void;
getAdditionalsecretoutputsList(): Array<string>;
setAdditionalsecretoutputsList(value: Array<string>): ReadResourceRequest;
addAdditionalsecretoutputs(value: string, index?: number): string;
getAcceptresources(): boolean;
setAcceptresources(value: boolean): ReadResourceRequest;
getPlugindownloadurl(): string;
setPlugindownloadurl(value: string): ReadResourceRequest;
getPluginchecksumsMap(): jspb.Map<string, Uint8Array | string>;
clearPluginchecksumsMap(): void;
hasSourceposition(): boolean;
clearSourceposition(): void;
getSourceposition(): pulumi_source_pb.SourcePosition | undefined;
setSourceposition(value?: pulumi_source_pb.SourcePosition): ReadResourceRequest;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): ReadResourceRequest.AsObject;
static toObject(includeInstance: boolean, msg: ReadResourceRequest): ReadResourceRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: ReadResourceRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): ReadResourceRequest;
static deserializeBinaryFromReader(message: ReadResourceRequest, reader: jspb.BinaryReader): ReadResourceRequest;
}
export namespace ReadResourceRequest {
export type AsObject = {
id: string,
type: string,
name: string,
parent: string,
properties?: google_protobuf_struct_pb.Struct.AsObject,
dependenciesList: Array<string>,
provider: string,
version: string,
acceptsecrets: boolean,
additionalsecretoutputsList: Array<string>,
acceptresources: boolean,
plugindownloadurl: string,
pluginchecksumsMap: Array<[string, Uint8Array | string]>,
sourceposition?: pulumi_source_pb.SourcePosition.AsObject,
}
}
export class ReadResourceResponse extends jspb.Message {
getUrn(): string;
setUrn(value: string): ReadResourceResponse;
hasProperties(): boolean;
clearProperties(): void;
getProperties(): google_protobuf_struct_pb.Struct | undefined;
setProperties(value?: google_protobuf_struct_pb.Struct): ReadResourceResponse;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): ReadResourceResponse.AsObject;
static toObject(includeInstance: boolean, msg: ReadResourceResponse): ReadResourceResponse.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: ReadResourceResponse, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): ReadResourceResponse;
static deserializeBinaryFromReader(message: ReadResourceResponse, reader: jspb.BinaryReader): ReadResourceResponse;
}
export namespace ReadResourceResponse {
export type AsObject = {
urn: string,
properties?: google_protobuf_struct_pb.Struct.AsObject,
}
}
export class RegisterResourceRequest extends jspb.Message {
getType(): string;
setType(value: string): RegisterResourceRequest;
getName(): string;
setName(value: string): RegisterResourceRequest;
getParent(): string;
setParent(value: string): RegisterResourceRequest;
getCustom(): boolean;
setCustom(value: boolean): RegisterResourceRequest;
hasObject(): boolean;
clearObject(): void;
getObject(): google_protobuf_struct_pb.Struct | undefined;
setObject(value?: google_protobuf_struct_pb.Struct): RegisterResourceRequest;
getProtect(): boolean;
setProtect(value: boolean): RegisterResourceRequest;
clearDependenciesList(): void;
getDependenciesList(): Array<string>;
setDependenciesList(value: Array<string>): RegisterResourceRequest;
addDependencies(value: string, index?: number): string;
getProvider(): string;
setProvider(value: string): RegisterResourceRequest;
getPropertydependenciesMap(): jspb.Map<string, RegisterResourceRequest.PropertyDependencies>;
clearPropertydependenciesMap(): void;
getDeletebeforereplace(): boolean;
setDeletebeforereplace(value: boolean): RegisterResourceRequest;
getVersion(): string;
setVersion(value: string): RegisterResourceRequest;
clearIgnorechangesList(): void;
getIgnorechangesList(): Array<string>;
setIgnorechangesList(value: Array<string>): RegisterResourceRequest;
addIgnorechanges(value: string, index?: number): string;
getAcceptsecrets(): boolean;
setAcceptsecrets(value: boolean): RegisterResourceRequest;
clearAdditionalsecretoutputsList(): void;
getAdditionalsecretoutputsList(): Array<string>;
setAdditionalsecretoutputsList(value: Array<string>): RegisterResourceRequest;
addAdditionalsecretoutputs(value: string, index?: number): string;
clearAliasurnsList(): void;
getAliasurnsList(): Array<string>;
setAliasurnsList(value: Array<string>): RegisterResourceRequest;
addAliasurns(value: string, index?: number): string;
getImportid(): string;
setImportid(value: string): RegisterResourceRequest;
hasCustomtimeouts(): boolean;
clearCustomtimeouts(): void;
getCustomtimeouts(): RegisterResourceRequest.CustomTimeouts | undefined;
setCustomtimeouts(value?: RegisterResourceRequest.CustomTimeouts): RegisterResourceRequest;
getDeletebeforereplacedefined(): boolean;
setDeletebeforereplacedefined(value: boolean): RegisterResourceRequest;
getSupportspartialvalues(): boolean;
setSupportspartialvalues(value: boolean): RegisterResourceRequest;
getRemote(): boolean;
setRemote(value: boolean): RegisterResourceRequest;
getAcceptresources(): boolean;
setAcceptresources(value: boolean): RegisterResourceRequest;
getProvidersMap(): jspb.Map<string, string>;
clearProvidersMap(): void;
clearReplaceonchangesList(): void;
getReplaceonchangesList(): Array<string>;
setReplaceonchangesList(value: Array<string>): RegisterResourceRequest;
addReplaceonchanges(value: string, index?: number): string;
getPlugindownloadurl(): string;
setPlugindownloadurl(value: string): RegisterResourceRequest;
getPluginchecksumsMap(): jspb.Map<string, Uint8Array | string>;
clearPluginchecksumsMap(): void;
getRetainondelete(): boolean;
setRetainondelete(value: boolean): RegisterResourceRequest;
clearAliasesList(): void;
getAliasesList(): Array<pulumi_alias_pb.Alias>;
setAliasesList(value: Array<pulumi_alias_pb.Alias>): RegisterResourceRequest;
addAliases(value?: pulumi_alias_pb.Alias, index?: number): pulumi_alias_pb.Alias;
getDeletedwith(): string;
setDeletedwith(value: string): RegisterResourceRequest;
getAliasspecs(): boolean;
setAliasspecs(value: boolean): RegisterResourceRequest;
hasSourceposition(): boolean;
clearSourceposition(): void;
getSourceposition(): pulumi_source_pb.SourcePosition | undefined;
setSourceposition(value?: pulumi_source_pb.SourcePosition): RegisterResourceRequest;
Engine support for remote transforms (#15290) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> This adds support to the engine for "remote transformations". A transform is "remote" because it is being invoked via the engine on receiving a resource registration, rather than being ran locally in process before sending a resource registration. These transforms can also span multiple process boundaries, e.g. a transform function in a user program, then a transform function in a component library, both running for a resource registered by another component library. The underlying new feature here is the idea of a `Callback`. The expectation is we're going to use callbacks for multiple features so these are _not_ defined in terms of transformations. A callback is an untyped byte array (usually will be a protobuf message), plus an address to define which server should be invoked to do the callback, and a token to identify it. A language sdk can start up and serve a `Callbacks` service, keep a mapping of tokens to in-process functions (currently just using UUID's for this), and then pass that service address and token to the engine to be invoked later on. The engine uses these callbacks to track transformations callbacks per resource, and on a new resource registrations invokes each relevant callback with the resource properties and options, having new properties and options returned that are then passed to the next relevant transform callback until all have been called and the engine has the final resource state and options to use. ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2024-02-21 16:30:46 +00:00
clearTransformsList(): void;
getTransformsList(): Array<pulumi_callback_pb.Callback>;
setTransformsList(value: Array<pulumi_callback_pb.Callback>): RegisterResourceRequest;
addTransforms(value?: pulumi_callback_pb.Callback, index?: number): pulumi_callback_pb.Callback;
getSupportsresultreporting(): boolean;
setSupportsresultreporting(value: boolean): RegisterResourceRequest;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): RegisterResourceRequest.AsObject;
static toObject(includeInstance: boolean, msg: RegisterResourceRequest): RegisterResourceRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: RegisterResourceRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): RegisterResourceRequest;
static deserializeBinaryFromReader(message: RegisterResourceRequest, reader: jspb.BinaryReader): RegisterResourceRequest;
}
export namespace RegisterResourceRequest {
export type AsObject = {
type: string,
name: string,
parent: string,
custom: boolean,
object?: google_protobuf_struct_pb.Struct.AsObject,
protect: boolean,
dependenciesList: Array<string>,
provider: string,
propertydependenciesMap: Array<[string, RegisterResourceRequest.PropertyDependencies.AsObject]>,
deletebeforereplace: boolean,
version: string,
ignorechangesList: Array<string>,
acceptsecrets: boolean,
additionalsecretoutputsList: Array<string>,
aliasurnsList: Array<string>,
importid: string,
customtimeouts?: RegisterResourceRequest.CustomTimeouts.AsObject,
deletebeforereplacedefined: boolean,
supportspartialvalues: boolean,
remote: boolean,
acceptresources: boolean,
providersMap: Array<[string, string]>,
replaceonchangesList: Array<string>,
plugindownloadurl: string,
pluginchecksumsMap: Array<[string, Uint8Array | string]>,
retainondelete: boolean,
aliasesList: Array<pulumi_alias_pb.Alias.AsObject>,
deletedwith: string,
aliasspecs: boolean,
sourceposition?: pulumi_source_pb.SourcePosition.AsObject,
Engine support for remote transforms (#15290) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> This adds support to the engine for "remote transformations". A transform is "remote" because it is being invoked via the engine on receiving a resource registration, rather than being ran locally in process before sending a resource registration. These transforms can also span multiple process boundaries, e.g. a transform function in a user program, then a transform function in a component library, both running for a resource registered by another component library. The underlying new feature here is the idea of a `Callback`. The expectation is we're going to use callbacks for multiple features so these are _not_ defined in terms of transformations. A callback is an untyped byte array (usually will be a protobuf message), plus an address to define which server should be invoked to do the callback, and a token to identify it. A language sdk can start up and serve a `Callbacks` service, keep a mapping of tokens to in-process functions (currently just using UUID's for this), and then pass that service address and token to the engine to be invoked later on. The engine uses these callbacks to track transformations callbacks per resource, and on a new resource registrations invokes each relevant callback with the resource properties and options, having new properties and options returned that are then passed to the next relevant transform callback until all have been called and the engine has the final resource state and options to use. ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2024-02-21 16:30:46 +00:00
transformsList: Array<pulumi_callback_pb.Callback.AsObject>,
supportsresultreporting: boolean,
}
export class PropertyDependencies extends jspb.Message {
clearUrnsList(): void;
getUrnsList(): Array<string>;
setUrnsList(value: Array<string>): PropertyDependencies;
addUrns(value: string, index?: number): string;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): PropertyDependencies.AsObject;
static toObject(includeInstance: boolean, msg: PropertyDependencies): PropertyDependencies.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: PropertyDependencies, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): PropertyDependencies;
static deserializeBinaryFromReader(message: PropertyDependencies, reader: jspb.BinaryReader): PropertyDependencies;
}
export namespace PropertyDependencies {
export type AsObject = {
urnsList: Array<string>,
}
}
export class CustomTimeouts extends jspb.Message {
getCreate(): string;
setCreate(value: string): CustomTimeouts;
getUpdate(): string;
setUpdate(value: string): CustomTimeouts;
getDelete(): string;
setDelete(value: string): CustomTimeouts;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): CustomTimeouts.AsObject;
static toObject(includeInstance: boolean, msg: CustomTimeouts): CustomTimeouts.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: CustomTimeouts, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): CustomTimeouts;
static deserializeBinaryFromReader(message: CustomTimeouts, reader: jspb.BinaryReader): CustomTimeouts;
}
export namespace CustomTimeouts {
export type AsObject = {
create: string,
update: string,
pb_delete: string,
}
}
}
export class RegisterResourceResponse extends jspb.Message {
getUrn(): string;
setUrn(value: string): RegisterResourceResponse;
getId(): string;
setId(value: string): RegisterResourceResponse;
hasObject(): boolean;
clearObject(): void;
getObject(): google_protobuf_struct_pb.Struct | undefined;
setObject(value?: google_protobuf_struct_pb.Struct): RegisterResourceResponse;
getStable(): boolean;
setStable(value: boolean): RegisterResourceResponse;
clearStablesList(): void;
getStablesList(): Array<string>;
setStablesList(value: Array<string>): RegisterResourceResponse;
addStables(value: string, index?: number): string;
getPropertydependenciesMap(): jspb.Map<string, RegisterResourceResponse.PropertyDependencies>;
clearPropertydependenciesMap(): void;
getResult(): Result;
setResult(value: Result): RegisterResourceResponse;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): RegisterResourceResponse.AsObject;
static toObject(includeInstance: boolean, msg: RegisterResourceResponse): RegisterResourceResponse.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: RegisterResourceResponse, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): RegisterResourceResponse;
static deserializeBinaryFromReader(message: RegisterResourceResponse, reader: jspb.BinaryReader): RegisterResourceResponse;
}
export namespace RegisterResourceResponse {
export type AsObject = {
urn: string,
id: string,
object?: google_protobuf_struct_pb.Struct.AsObject,
stable: boolean,
stablesList: Array<string>,
propertydependenciesMap: Array<[string, RegisterResourceResponse.PropertyDependencies.AsObject]>,
result: Result,
}
export class PropertyDependencies extends jspb.Message {
clearUrnsList(): void;
getUrnsList(): Array<string>;
setUrnsList(value: Array<string>): PropertyDependencies;
addUrns(value: string, index?: number): string;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): PropertyDependencies.AsObject;
static toObject(includeInstance: boolean, msg: PropertyDependencies): PropertyDependencies.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: PropertyDependencies, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): PropertyDependencies;
static deserializeBinaryFromReader(message: PropertyDependencies, reader: jspb.BinaryReader): PropertyDependencies;
}
export namespace PropertyDependencies {
export type AsObject = {
urnsList: Array<string>,
}
}
}
export class RegisterResourceOutputsRequest extends jspb.Message {
getUrn(): string;
setUrn(value: string): RegisterResourceOutputsRequest;
hasOutputs(): boolean;
clearOutputs(): void;
getOutputs(): google_protobuf_struct_pb.Struct | undefined;
setOutputs(value?: google_protobuf_struct_pb.Struct): RegisterResourceOutputsRequest;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): RegisterResourceOutputsRequest.AsObject;
static toObject(includeInstance: boolean, msg: RegisterResourceOutputsRequest): RegisterResourceOutputsRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: RegisterResourceOutputsRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): RegisterResourceOutputsRequest;
static deserializeBinaryFromReader(message: RegisterResourceOutputsRequest, reader: jspb.BinaryReader): RegisterResourceOutputsRequest;
}
export namespace RegisterResourceOutputsRequest {
export type AsObject = {
urn: string,
outputs?: google_protobuf_struct_pb.Struct.AsObject,
}
}
export class ResourceInvokeRequest extends jspb.Message {
getTok(): string;
setTok(value: string): ResourceInvokeRequest;
hasArgs(): boolean;
clearArgs(): void;
getArgs(): google_protobuf_struct_pb.Struct | undefined;
setArgs(value?: google_protobuf_struct_pb.Struct): ResourceInvokeRequest;
getProvider(): string;
setProvider(value: string): ResourceInvokeRequest;
getVersion(): string;
setVersion(value: string): ResourceInvokeRequest;
getAcceptresources(): boolean;
setAcceptresources(value: boolean): ResourceInvokeRequest;
getPlugindownloadurl(): string;
setPlugindownloadurl(value: string): ResourceInvokeRequest;
getPluginchecksumsMap(): jspb.Map<string, Uint8Array | string>;
clearPluginchecksumsMap(): void;
hasSourceposition(): boolean;
clearSourceposition(): void;
getSourceposition(): pulumi_source_pb.SourcePosition | undefined;
setSourceposition(value?: pulumi_source_pb.SourcePosition): ResourceInvokeRequest;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): ResourceInvokeRequest.AsObject;
static toObject(includeInstance: boolean, msg: ResourceInvokeRequest): ResourceInvokeRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: ResourceInvokeRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): ResourceInvokeRequest;
static deserializeBinaryFromReader(message: ResourceInvokeRequest, reader: jspb.BinaryReader): ResourceInvokeRequest;
}
export namespace ResourceInvokeRequest {
export type AsObject = {
tok: string,
args?: google_protobuf_struct_pb.Struct.AsObject,
provider: string,
version: string,
acceptresources: boolean,
plugindownloadurl: string,
pluginchecksumsMap: Array<[string, Uint8Array | string]>,
sourceposition?: pulumi_source_pb.SourcePosition.AsObject,
}
}
Split CallRequest into ResourceCallRequest (#15404) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Similar to what we did to the `InvokeRequest` a while ago. We're currently using the same protobuf structure for `Provider.Call` and `ResourceMonitor.Call` despite different field sets being filled in for each of them. This splits the structure into `CallRequest` for providers and `ResourceCallRequest` for the resource monitor. A number of fields in each are removed and marked reserved with a comment explaining why. ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [ ] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2024-02-08 13:16:23 +00:00
export class ResourceCallRequest extends jspb.Message {
getTok(): string;
setTok(value: string): ResourceCallRequest;
hasArgs(): boolean;
clearArgs(): void;
getArgs(): google_protobuf_struct_pb.Struct | undefined;
setArgs(value?: google_protobuf_struct_pb.Struct): ResourceCallRequest;
getArgdependenciesMap(): jspb.Map<string, ResourceCallRequest.ArgumentDependencies>;
clearArgdependenciesMap(): void;
getProvider(): string;
setProvider(value: string): ResourceCallRequest;
getVersion(): string;
setVersion(value: string): ResourceCallRequest;
getPlugindownloadurl(): string;
setPlugindownloadurl(value: string): ResourceCallRequest;
getPluginchecksumsMap(): jspb.Map<string, Uint8Array | string>;
clearPluginchecksumsMap(): void;
hasSourceposition(): boolean;
clearSourceposition(): void;
getSourceposition(): pulumi_source_pb.SourcePosition | undefined;
setSourceposition(value?: pulumi_source_pb.SourcePosition): ResourceCallRequest;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): ResourceCallRequest.AsObject;
static toObject(includeInstance: boolean, msg: ResourceCallRequest): ResourceCallRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: ResourceCallRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): ResourceCallRequest;
static deserializeBinaryFromReader(message: ResourceCallRequest, reader: jspb.BinaryReader): ResourceCallRequest;
}
export namespace ResourceCallRequest {
export type AsObject = {
tok: string,
args?: google_protobuf_struct_pb.Struct.AsObject,
argdependenciesMap: Array<[string, ResourceCallRequest.ArgumentDependencies.AsObject]>,
provider: string,
version: string,
plugindownloadurl: string,
pluginchecksumsMap: Array<[string, Uint8Array | string]>,
sourceposition?: pulumi_source_pb.SourcePosition.AsObject,
}
export class ArgumentDependencies extends jspb.Message {
clearUrnsList(): void;
getUrnsList(): Array<string>;
setUrnsList(value: Array<string>): ArgumentDependencies;
addUrns(value: string, index?: number): string;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): ArgumentDependencies.AsObject;
static toObject(includeInstance: boolean, msg: ArgumentDependencies): ArgumentDependencies.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: ArgumentDependencies, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): ArgumentDependencies;
static deserializeBinaryFromReader(message: ArgumentDependencies, reader: jspb.BinaryReader): ArgumentDependencies;
}
export namespace ArgumentDependencies {
export type AsObject = {
urnsList: Array<string>,
}
}
}
Engine support for remote transforms (#15290) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> This adds support to the engine for "remote transformations". A transform is "remote" because it is being invoked via the engine on receiving a resource registration, rather than being ran locally in process before sending a resource registration. These transforms can also span multiple process boundaries, e.g. a transform function in a user program, then a transform function in a component library, both running for a resource registered by another component library. The underlying new feature here is the idea of a `Callback`. The expectation is we're going to use callbacks for multiple features so these are _not_ defined in terms of transformations. A callback is an untyped byte array (usually will be a protobuf message), plus an address to define which server should be invoked to do the callback, and a token to identify it. A language sdk can start up and serve a `Callbacks` service, keep a mapping of tokens to in-process functions (currently just using UUID's for this), and then pass that service address and token to the engine to be invoked later on. The engine uses these callbacks to track transformations callbacks per resource, and on a new resource registrations invokes each relevant callback with the resource properties and options, having new properties and options returned that are then passed to the next relevant transform callback until all have been called and the engine has the final resource state and options to use. ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2024-02-21 16:30:46 +00:00
export class TransformResourceOptions extends jspb.Message {
clearDependsOnList(): void;
getDependsOnList(): Array<string>;
setDependsOnList(value: Array<string>): TransformResourceOptions;
addDependsOn(value: string, index?: number): string;
getProtect(): boolean;
setProtect(value: boolean): TransformResourceOptions;
clearIgnoreChangesList(): void;
getIgnoreChangesList(): Array<string>;
setIgnoreChangesList(value: Array<string>): TransformResourceOptions;
addIgnoreChanges(value: string, index?: number): string;
clearReplaceOnChangesList(): void;
getReplaceOnChangesList(): Array<string>;
setReplaceOnChangesList(value: Array<string>): TransformResourceOptions;
addReplaceOnChanges(value: string, index?: number): string;
getVersion(): string;
setVersion(value: string): TransformResourceOptions;
clearAliasesList(): void;
getAliasesList(): Array<pulumi_alias_pb.Alias>;
setAliasesList(value: Array<pulumi_alias_pb.Alias>): TransformResourceOptions;
addAliases(value?: pulumi_alias_pb.Alias, index?: number): pulumi_alias_pb.Alias;
getProvider(): string;
setProvider(value: string): TransformResourceOptions;
hasCustomTimeouts(): boolean;
clearCustomTimeouts(): void;
getCustomTimeouts(): RegisterResourceRequest.CustomTimeouts | undefined;
setCustomTimeouts(value?: RegisterResourceRequest.CustomTimeouts): TransformResourceOptions;
getPluginDownloadUrl(): string;
setPluginDownloadUrl(value: string): TransformResourceOptions;
getRetainOnDelete(): boolean;
setRetainOnDelete(value: boolean): TransformResourceOptions;
getDeletedWith(): string;
setDeletedWith(value: string): TransformResourceOptions;
hasDeleteBeforeReplace(): boolean;
clearDeleteBeforeReplace(): void;
getDeleteBeforeReplace(): boolean | undefined;
setDeleteBeforeReplace(value: boolean): TransformResourceOptions;
clearAdditionalSecretOutputsList(): void;
getAdditionalSecretOutputsList(): Array<string>;
setAdditionalSecretOutputsList(value: Array<string>): TransformResourceOptions;
addAdditionalSecretOutputs(value: string, index?: number): string;
getProvidersMap(): jspb.Map<string, string>;
clearProvidersMap(): void;
getPluginChecksumsMap(): jspb.Map<string, Uint8Array | string>;
clearPluginChecksumsMap(): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): TransformResourceOptions.AsObject;
static toObject(includeInstance: boolean, msg: TransformResourceOptions): TransformResourceOptions.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: TransformResourceOptions, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): TransformResourceOptions;
static deserializeBinaryFromReader(message: TransformResourceOptions, reader: jspb.BinaryReader): TransformResourceOptions;
}
export namespace TransformResourceOptions {
export type AsObject = {
dependsOnList: Array<string>,
protect: boolean,
ignoreChangesList: Array<string>,
replaceOnChangesList: Array<string>,
version: string,
aliasesList: Array<pulumi_alias_pb.Alias.AsObject>,
provider: string,
customTimeouts?: RegisterResourceRequest.CustomTimeouts.AsObject,
pluginDownloadUrl: string,
retainOnDelete: boolean,
deletedWith: string,
deleteBeforeReplace?: boolean,
additionalSecretOutputsList: Array<string>,
providersMap: Array<[string, string]>,
pluginChecksumsMap: Array<[string, Uint8Array | string]>,
}
}
export class TransformRequest extends jspb.Message {
getType(): string;
setType(value: string): TransformRequest;
getName(): string;
setName(value: string): TransformRequest;
getCustom(): boolean;
setCustom(value: boolean): TransformRequest;
getParent(): string;
setParent(value: string): TransformRequest;
hasProperties(): boolean;
clearProperties(): void;
getProperties(): google_protobuf_struct_pb.Struct | undefined;
setProperties(value?: google_protobuf_struct_pb.Struct): TransformRequest;
hasOptions(): boolean;
clearOptions(): void;
getOptions(): TransformResourceOptions | undefined;
setOptions(value?: TransformResourceOptions): TransformRequest;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): TransformRequest.AsObject;
static toObject(includeInstance: boolean, msg: TransformRequest): TransformRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: TransformRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): TransformRequest;
static deserializeBinaryFromReader(message: TransformRequest, reader: jspb.BinaryReader): TransformRequest;
}
export namespace TransformRequest {
export type AsObject = {
type: string,
name: string,
custom: boolean,
parent: string,
properties?: google_protobuf_struct_pb.Struct.AsObject,
options?: TransformResourceOptions.AsObject,
}
}
export class TransformResponse extends jspb.Message {
hasProperties(): boolean;
clearProperties(): void;
getProperties(): google_protobuf_struct_pb.Struct | undefined;
setProperties(value?: google_protobuf_struct_pb.Struct): TransformResponse;
hasOptions(): boolean;
clearOptions(): void;
getOptions(): TransformResourceOptions | undefined;
setOptions(value?: TransformResourceOptions): TransformResponse;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): TransformResponse.AsObject;
static toObject(includeInstance: boolean, msg: TransformResponse): TransformResponse.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: TransformResponse, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): TransformResponse;
static deserializeBinaryFromReader(message: TransformResponse, reader: jspb.BinaryReader): TransformResponse;
}
export namespace TransformResponse {
export type AsObject = {
properties?: google_protobuf_struct_pb.Struct.AsObject,
options?: TransformResourceOptions.AsObject,
}
}
RegisterProvider engine work (#16241) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> This adds support for a `RegisterProvider` method to the engine. This allows an SDK process to send the information for a package (name, version, url, etc, and parameter in the future) and get back a UUID for that run of the engine that can be used to re-lookup that information. That allows the SDK to just send the `provider` field in `RegisterResourceRequest` instead of filling in `version`, `pluginDownloadURL` etc (and importantly not having to fill in `parameter` for parameterised providers, which could be a large amount of data). This doesn't update any of the SDKs to yet use this method. We can do that piecemeal, but it will require core sdk and codegen changes for each language. ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [ ] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2024-05-23 06:16:59 +00:00
export class RegisterProviderRequest extends jspb.Message {
getName(): string;
setName(value: string): RegisterProviderRequest;
getVersion(): string;
setVersion(value: string): RegisterProviderRequest;
getPluginDownloadUrl(): string;
setPluginDownloadUrl(value: string): RegisterProviderRequest;
getPluginChecksumsMap(): jspb.Map<string, Uint8Array | string>;
clearPluginChecksumsMap(): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): RegisterProviderRequest.AsObject;
static toObject(includeInstance: boolean, msg: RegisterProviderRequest): RegisterProviderRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: RegisterProviderRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): RegisterProviderRequest;
static deserializeBinaryFromReader(message: RegisterProviderRequest, reader: jspb.BinaryReader): RegisterProviderRequest;
}
export namespace RegisterProviderRequest {
export type AsObject = {
name: string,
version: string,
pluginDownloadUrl: string,
pluginChecksumsMap: Array<[string, Uint8Array | string]>,
}
}
export class RegisterProviderResponse extends jspb.Message {
getRef(): string;
setRef(value: string): RegisterProviderResponse;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): RegisterProviderResponse.AsObject;
static toObject(includeInstance: boolean, msg: RegisterProviderResponse): RegisterProviderResponse.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: RegisterProviderResponse, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): RegisterProviderResponse;
static deserializeBinaryFromReader(message: RegisterProviderResponse, reader: jspb.BinaryReader): RegisterProviderResponse;
}
export namespace RegisterProviderResponse {
export type AsObject = {
ref: string,
}
}
export enum Result {
SUCCESS = 0,
FAIL = 1,
SKIP = 2,
}