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(java.lang.String token, TypeShape<T> targetType, CallArgs args)	Same as call(String, TypeShape, CallArgs, Resource, CallOptions)
<T> Output<T>	call(java.lang.String token, TypeShape<T> targetType, CallArgs args, Resource self)	Same as call(String, TypeShape, CallArgs, Resource, CallOptions)
<T> Output<T>	call(java.lang.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(java.lang.String token, CallArgs args)	Same as call(String, TypeShape, CallArgs, Resource, CallOptions), however the return value is ignored.
void	call(java.lang.String token, CallArgs args, Resource self)	Same as call(String, TypeShape, CallArgs, Resource, CallOptions), however the return value is ignored.
void	call(java.lang.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 java.lang.String	getOrganizationName()
java.lang.String	getProjectName()
java.lang.String	getStackName()
<T> Output<T>	invoke(java.lang.String token, TypeShape<T> targetType, InvokeArgs args)	Same as @see invoke(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)
<T> Output<T>	invoke(java.lang.String token, TypeShape<T> targetType, InvokeArgs args, InvokeOptions options)	Same as @see invoke(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)
<T> Output<T>	invoke(java.lang.String token, TypeShape<T> targetType, InvokeArgs args, InvokeOptions options, java.util.concurrent.CompletableFuture<java.lang.String> packageRef)	Dynamically invokes the function token, which is offered by a provider plugin.
<T> Output<T>	invoke(java.lang.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(java.lang.String token, TypeShape<T> targetType, InvokeArgs args, InvokeOutputOptions options, java.util.concurrent.CompletableFuture<java.lang.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> java.util.concurrent.CompletableFuture<T>	invokeAsync(java.lang.String token, TypeShape<T> targetType, InvokeArgs args)	Same as @see invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)
<T> java.util.concurrent.CompletableFuture<T>	invokeAsync(java.lang.String token, TypeShape<T> targetType, InvokeArgs args, InvokeOptions options)	Same as @see invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture)
<T> java.util.concurrent.CompletableFuture<T>	invokeAsync(java.lang.String token, TypeShape<T> targetType, InvokeArgs args, InvokeOptions options, java.util.concurrent.CompletableFuture<java.lang.String> packageRef)	Dynamically invokes the function token, which is offered by a provider plugin.
java.util.concurrent.CompletableFuture<java.lang.Void>	invokeAsync(java.lang.String token, InvokeArgs args)	Same as @see invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions, CompletableFuture), however the return value is ignored.
java.util.concurrent.CompletableFuture<java.lang.Void>	invokeAsync(java.lang.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.
java.util.concurrent.CompletableFuture<java.lang.String>	registerPackage(java.lang.String baseProviderName, java.lang.String baseProviderVersion, java.lang.String baseProviderDownloadUrl, java.lang.String packageName, java.lang.String packageVersion, java.lang.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.

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

readOrRegisterResource

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

registerResourceOutputs

Method Detail

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:

java.lang.IllegalStateException - if called before 'run' was called

getStackName

@Nonnull
java.lang.String getStackName()

Returns:

the current stack name

getProjectName

@Nonnull
java.lang.String getProjectName()

Returns:

the current project name

getOrganizationName

@Nonnull
default java.lang.String getOrganizationName()

Returns:

the current organization name

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(java.lang.String token,
                     TypeShape<T> targetType,
                     InvokeArgs args)

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

invoke

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

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

invoke

<T> Output<T> invoke(java.lang.String token,
                     TypeShape<T> targetType,
                     InvokeArgs args,
                     @Nullable
                     InvokeOptions options,
                     java.util.concurrent.CompletableFuture<java.lang.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(java.lang.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(java.lang.String token,
                     TypeShape<T> targetType,
                     InvokeArgs args,
                     @Nullable
                     InvokeOutputOptions options,
                     java.util.concurrent.CompletableFuture<java.lang.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

java.util.concurrent.CompletableFuture<java.lang.Void> invokeAsync(java.lang.String token,
                                                                   InvokeArgs args)

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

invokeAsync

java.util.concurrent.CompletableFuture<java.lang.Void> invokeAsync(java.lang.String token,
                                                                   InvokeArgs args,
                                                                   InvokeOptions options)

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

invokeAsync

<T> java.util.concurrent.CompletableFuture<T> invokeAsync(java.lang.String token,
                                                          TypeShape<T> targetType,
                                                          InvokeArgs args)

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

invokeAsync

<T> java.util.concurrent.CompletableFuture<T> invokeAsync(java.lang.String token,
                                                          TypeShape<T> targetType,
                                                          InvokeArgs args,
                                                          InvokeOptions options)

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

invokeAsync

<T> java.util.concurrent.CompletableFuture<T> invokeAsync(java.lang.String token,
                                                          TypeShape<T> targetType,
                                                          InvokeArgs args,
                                                          InvokeOptions options,
                                                          java.util.concurrent.CompletableFuture<java.lang.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(java.lang.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(java.lang.String token,
                   TypeShape<T> targetType,
                   CallArgs args,
                   @Nullable
                   Resource self)

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

call

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

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

call

void call(java.lang.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(java.lang.String token,
          CallArgs args,
          @Nullable
          Resource self)

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

call

void call(java.lang.String token,
          CallArgs args)

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

registerPackage

java.util.concurrent.CompletableFuture<java.lang.String> registerPackage(java.lang.String baseProviderName,
                                                                         java.lang.String baseProviderVersion,
                                                                         java.lang.String baseProviderDownloadUrl,
                                                                         java.lang.String packageName,
                                                                         java.lang.String packageVersion,
                                                                         java.lang.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