Package com.pulumi.deployment

Interface Deployment

All Superinterfaces:

com.pulumi.deployment.internal.ReadOrRegisterResource, com.pulumi.deployment.internal.RegisterResourceOutputs

All Known Subinterfaces:

DeploymentInstance

All Known Implementing Classes:

MockDeployment

@InternalUse
public interface Deployment
extends com.pulumi.deployment.internal.ReadOrRegisterResource, com.pulumi.deployment.internal.RegisterResourceOutputs

Method Summary

Modifier and Type	Method	Description
<T> Output<T>	call(String token, TypeShape<T> targetType, CallArgs args)	Same as call(String, TypeShape, CallArgs, Resource, CallOptions)
<T> Output<T>	call(String token, TypeShape<T> targetType, CallArgs args, Resource self)	Same as call(String, TypeShape, CallArgs, Resource, CallOptions)
<T> Output<T>	call(String token, TypeShape<T> targetType, CallArgs args, Resource self, CallOptions options)	Dynamically calls the function token, which is offered by a provider plugin.
void	call(String token, CallArgs args)	Same as call(String, TypeShape, CallArgs, Resource, CallOptions), however the return value is ignored.
void	call(String token, CallArgs args, Resource self)	Same as call(String, TypeShape, CallArgs, Resource, CallOptions), however the return value is ignored.
void	call(String token, CallArgs args, Resource self, CallOptions options)	Same as call(String, TypeShape, CallArgs, Resource, CallOptions), however the return value is ignored.
static DeploymentInstance	getInstance()	The current running deployment instance.
default String	getOrganizationName()
String	getProjectName()
String	getRootDirectory()
String	getStackName()
<T> Output<T>	invoke(String token, TypeShape<T> targetType, InvokeArgs args)	Same as @see invoke(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)
<T> Output<T>	invoke(String token, TypeShape<T> targetType, InvokeArgs args, InvokeOptions options)	Same as @see invoke(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)
<T> Output<T>	invoke(String token, TypeShape<T> targetType, InvokeArgs args, InvokeOptions options, CompletableFuture<String> packageRef)	Dynamically invokes the function token, which is offered by a provider plugin.
<T> Output<T>	invoke(String token, TypeShape<T> targetType, InvokeArgs args, InvokeOutputOptions options)	Same as @see invoke(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture) but takes InvokeOutputOptions as options, which allows setting InvokeOutputOptions.dependsOn to specify additional resource dependencies besides the ones that are automatically detected from the InvokeArgs.
<T> Output<T>	invoke(String token, TypeShape<T> targetType, InvokeArgs args, InvokeOutputOptions options, CompletableFuture<String> packageRef)	Same as @see invoke(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture) but takes InvokeOutputOptions as options, which allows setting InvokeOutputOptions.dependsOn to specify additional resource dependencies besides the ones that are automatically detected from the InvokeArgs.
<T> CompletableFuture<T>	invokeAsync(String token, TypeShape<T> targetType, InvokeArgs args)	Same as @see invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)
<T> CompletableFuture<T>	invokeAsync(String token, TypeShape<T> targetType, InvokeArgs args, InvokeOptions options)	Same as @see invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)
<T> CompletableFuture<T>	invokeAsync(String token, TypeShape<T> targetType, InvokeArgs args, InvokeOptions options, CompletableFuture<String> packageRef)	Dynamically invokes the function token, which is offered by a provider plugin.
CompletableFuture<Void>	invokeAsync(String token, InvokeArgs args)	Same as @see invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture), however the return value is ignored.
CompletableFuture<Void>	invokeAsync(String token, InvokeArgs args, InvokeOptions options)	Same as @see invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture), however the return value is ignored.
boolean	isDryRun()	Whether the application is currently being previewed or actually applied.
CompletableFuture<String>	registerPackage(String baseProviderName, String baseProviderVersion, String baseProviderDownloadUrl, String packageName, String packageVersion, String base64Parameter)	Registers a parameterization of a given provider, returning a package reference that can be used to instantiate resources and call functions against it.
default CompletableFuture<String>	registerPackage(String baseProviderName, String baseProviderVersion, String baseProviderDownloadUrl, String packageName, String packageVersion, String base64Parameter, boolean extension)	Registers a parameterization of a given provider, returning a package reference that can be used to instantiate resources and call functions against it.
void	requirePulumiVersion(String range)	Checks if the engine we are connected to is compatible with the passed in version range.

Methods inherited from interface com.pulumi.deployment.internal.ReadOrRegisterResource

readOrRegisterResource

Methods inherited from interface com.pulumi.deployment.internal.RegisterResourceOutputs

registerResourceOutputs

Method Details

getInstance

@InternalUse
static DeploymentInstance getInstance()

The current running deployment instance. This is only available from inside the function passed to @see Runner.runAsync(Supplier) (or its overloads).

Throws:

IllegalStateException - if called before 'run' was called

getStackName

@Nonnull
String getStackName()

Returns:

the current stack name

getProjectName

@Nonnull
String getProjectName()

Returns:

the current project name

getOrganizationName

@Nonnull
default String getOrganizationName()

Returns:

the current organization name

getRootDirectory

@Nonnull
String getRootDirectory()

Returns:

the root directory of the current project, where Pulumi.yaml lives

requirePulumiVersion

void requirePulumiVersion(String range)

Checks if the engine we are connected to is compatible with the passed in version range. If the version is not compatible with the specified range, an exception is raised.

The supported syntax for the range is that of github.com/blang/semver#ParseRange. For example ">=3.0.0", or "!3.1.2". Ranges can be AND-ed together by concatenating with spaces ">=3.5.0 !3.7.7", meaning greater-or-equal to 3.5.0 and not exactly 3.7.7. Ranges can be OR-ed with the || operator: "<3.4.0 || >3.8.0", meaning less-than 3.4.0 or greater-than 3.8.0.

Parameters:

range - the version range to check against

isDryRun

boolean isDryRun()

Whether the application is currently being previewed or actually applied.

Returns:

true if application is being applied

invoke

<T> Output<T> invoke(String token,
 TypeShape<T> targetType,
 InvokeArgs args)

Same as @see invoke(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)

invoke

<T> Output<T> invoke(String token,
 TypeShape<T> targetType,
 InvokeArgs args,
 @Nullable
 InvokeOptions options)

Same as @see invoke(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)

invoke

<T> Output<T> invoke(String token,
 TypeShape<T> targetType,
 InvokeArgs args,
 @Nullable
 InvokeOptions options,
 CompletableFuture<String> packageRef)

Dynamically invokes the function token, which is offered by a provider plugin.

The result of invoke will be an @see Output<T> resolved to the result value of the provider plugin.

The args inputs can be a bag of computed values (including, Ts, @see CompletableFutures, @see Outputs, etc.)

invoke

<T> Output<T> invoke(String token,
 TypeShape<T> targetType,
 InvokeArgs args,
 @Nullable
 InvokeOutputOptions options)

Same as @see invoke(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture) but takes InvokeOutputOptions as options, which allows setting InvokeOutputOptions.dependsOn to specify additional resource dependencies besides the ones that are automatically detected from the InvokeArgs.

invoke

<T> Output<T> invoke(String token,
 TypeShape<T> targetType,
 InvokeArgs args,
 @Nullable
 InvokeOutputOptions options,
 CompletableFuture<String> packageRef)

Same as @see invoke(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture) but takes InvokeOutputOptions as options, which allows setting InvokeOutputOptions.dependsOn to specify additional resource dependencies besides the ones that are automatically detected from the InvokeArgs.

invokeAsync

CompletableFuture<Void> invokeAsync(String token,
 InvokeArgs args)

Same as @see invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture), however the return value is ignored.

invokeAsync

CompletableFuture<Void> invokeAsync(String token,
 InvokeArgs args,
 InvokeOptions options)

Same as @see invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture), however the return value is ignored.

invokeAsync

<T> CompletableFuture<T> invokeAsync(String token,
 TypeShape<T> targetType,
 InvokeArgs args)

Same as @see invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)

invokeAsync

<T> CompletableFuture<T> invokeAsync(String token,
 TypeShape<T> targetType,
 InvokeArgs args,
 InvokeOptions options)

Same as @see invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)

invokeAsync

<T> CompletableFuture<T> invokeAsync(String token,
 TypeShape<T> targetType,
 InvokeArgs args,
 InvokeOptions options,
 CompletableFuture<String> packageRef)

Dynamically invokes the function token, which is offered by a provider plugin.

The result of invokeAsync will be a @see CompletableFuture resolved to the result value of the provider plugin.

The args inputs can be a bag of computed values (including, Ts, @see CompletableFutures, @see Outputs, etc.).

call

<T> Output<T> call(String token,
 TypeShape<T> targetType,
 CallArgs args,
 @Nullable
 Resource self,
 @Nullable
 CallOptions options)

Dynamically calls the function token, which is offered by a provider plugin.

The result of call will be an @see Output<T> resolved to the result value of the provider plugin.

The args inputs can be a bag of computed values (including, Ts, @see CompletableFutures, @see Outputs, etc.).

call

<T> Output<T> call(String token,
 TypeShape<T> targetType,
 CallArgs args,
 @Nullable
 Resource self)

Same as call(String, TypeShape, CallArgs, Resource, CallOptions)

call

<T> Output<T> call(String token,
 TypeShape<T> targetType,
 CallArgs args)

Same as call(String, TypeShape, CallArgs, Resource, CallOptions)

call

void call(String token,
 CallArgs args,
 @Nullable
 Resource self,
 @Nullable
 CallOptions options)

Same as call(String, TypeShape, CallArgs, Resource, CallOptions), however the return value is ignored.

call

void call(String token,
 CallArgs args,
 @Nullable
 Resource self)

Same as call(String, TypeShape, CallArgs, Resource, CallOptions), however the return value is ignored.

call

void call(String token,
 CallArgs args)

Same as call(String, TypeShape, CallArgs, Resource, CallOptions), however the return value is ignored.

registerPackage

CompletableFuture<String> registerPackage(String baseProviderName,
 String baseProviderVersion,
 String baseProviderDownloadUrl,
 String packageName,
 String packageVersion,
 String base64Parameter)

Registers a parameterization of a given provider, returning a package reference that can be used to instantiate resources and call functions against it.

Parameters:

baseProviderName - The name of the base provider being parameterized

baseProviderVersion - The version of the base provider being parameterized

baseProviderDownloadUrl - The download URL of the base provider being parameterized

packageName - The name of the package being registered

packageVersion - The version of the package being registered

base64Parameter - The base64-encoded parameterization of the base provider

Returns:

A future that resolves to the package reference

registerPackage

default CompletableFuture<String> registerPackage(String baseProviderName,
 String baseProviderVersion,
 String baseProviderDownloadUrl,
 String packageName,
 String packageVersion,
 String base64Parameter,
 boolean extension)

Registers a parameterization of a given provider, returning a package reference that can be used to instantiate resources and call functions against it.

Parameters:

baseProviderName - The name of the base provider being parameterized

baseProviderVersion - The version of the base provider being parameterized

baseProviderDownloadUrl - The download URL of the base provider being parameterized

packageName - The name of the package being registered

packageVersion - The version of the package being registered

base64Parameter - The base64-encoded parameterization of the base provider

extension - Whether this is an extension parameterization (resources layered onto the base provider) rather than a replacement parameterization

Returns:

A future that resolves to the package reference