package agent

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc AddEnvironments (AddEnvironmentsRequest, AddEnvironmentsResult)

  agent.proto:36

  * AddEnvironments adds environments to the end of a stack's import list.

  message AddEnvironmentsRequest

  agent.proto:127

  • repeated string environment = 1

    The ESC environment(s) to add to the configuration.

  message AddEnvironmentsResult

  agent.proto:131

  (message has no fields)

• rpc Destroy (DestroyRequest, stream DestroyStream)

  agent.proto:64

  * Destroy deletes all resources in a stack.

  message DestroyRequest

  agent.proto:259

  • optional int32 parallel = 1

    Parallel is the number of resource operations to run in parallel at once (1 for no parallelism). Defaults to unbounded. (default 2147483647)

  • optional string message = 2

    Message (optional) to associate with the destroy operation

  • repeated string target = 3

    Specify an exclusive list of resource URNs to destroy

  • optional bool target_dependents = 4

    Allows updating of dependent targets discovered but not specified in the Target list

  • optional bool refresh = 5

    Refresh will run a refresh before the destroy.

  • optional bool continue_on_error = 6

    continue_on_error will continue to perform the update operation despite the occurrence of errors.

  • optional bool remove = 7

    Remove the stack and its configuration after all resources in the stack have been deleted.

  message DestroyStream

  agent.proto:280

  • oneof response

    • google.protobuf.Struct event = 1

      describes a Pulumi engine event, such as a change to a resource or diagnostic message.

    • DestroyResult result = 2

• rpc Info (InfoRequest, InfoResult)

  agent.proto:26

  * Info returns information about the given stack.

  message InfoRequest

  agent.proto:90

  (message has no fields)

  message InfoResult

  agent.proto:92

  • optional StackSummary summary = 1

• rpc Install (InstallRequest, InstallResult)

  agent.proto:41

  * Install installs the Pulumi plugins and dependencies.

  message InstallRequest

  agent.proto:133

  (message has no fields)

  message InstallResult

  agent.proto:135

  (message has no fields)

• rpc Preview (PreviewRequest, stream PreviewStream)

  agent.proto:47

  * Preview performs a dry-run update to a stack, returning the expected changes.

  message PreviewRequest

  agent.proto:165

  • optional int32 parallel = 1

    Parallel is the number of resource operations to run in parallel at once (1 for no parallelism). Defaults to unbounded. (default 2147483647)

  • optional string message = 2

    Message (optional) to associate with the preview operation

  • optional bool expect_no_changes = 3

    Return an error if any changes occur during this preview

  • repeated string replace = 4

    Specify resources to replace

  • repeated string target = 5

    Specify an exclusive list of resource URNs to update

  • optional bool target_dependents = 6

    Allows updating of dependent targets discovered but not specified in the Target list

  • repeated PolicyPack policy_pack = 7

    Run one or more policy packs as part of this update

  • optional bool refresh = 8

    Refresh will run a refresh before the preview.

  message PreviewStream

  agent.proto:188

  • oneof response

    • google.protobuf.Struct event = 1

      describes a Pulumi engine event, such as a change to a resource or diagnostic message.

    • PreviewResult result = 2

• rpc PulumiVersion (PulumiVersionRequest, PulumiVersionResult)

  agent.proto:69

  * PulumiVersion returns the version of the Pulumi CLI.

  message PulumiVersionRequest

  agent.proto:303

  (message has no fields)

  message PulumiVersionResult

  agent.proto:305

  • string version = 1

    e.g., "v3.200.0"

• rpc Refresh (RefreshRequest, stream RefreshStream)

  agent.proto:53

  * Refresh updates the resources in a stack to match the current state of the cloud provider.

  message RefreshRequest

  agent.proto:137

  • optional int32 parallel = 1

    parallel is the number of resource operations to run in parallel at once (1 for no parallelism). Defaults to unbounded. (default 2147483647)

  • optional string message = 2

    message (optional) to associate with the preview operation

  • optional bool expect_no_changes = 3

    Return an error if any changes occur during this refresh

  • repeated string target = 4

    Specify an exclusive list of resource URNs to refresh

  message RefreshStream

  agent.proto:149

  • oneof response

    • google.protobuf.Struct event = 1

      describes a Pulumi engine event, such as a change to a resource or diagnostic message.

    • RefreshResult result = 2

• rpc SelectStack (SelectStackRequest, SelectStackResult)

  agent.proto:21

  * Info returns information about the given stack.

  message SelectStackRequest

  agent.proto:82

  • string stack_name = 1

  • optional bool create = 2

  • optional string secrets_provider = 3

  message SelectStackResult

  agent.proto:88

  • optional StackSummary summary = 1

• rpc SetAllConfig (SetAllConfigRequest, SetAllConfigResult)

  agent.proto:31

  * SetAllConfig sets multiple configuration values for a stack.

  message SetAllConfigRequest

  agent.proto:103

  • repeated ConfigItem config = 1

    The config items to add to the configuration.

  message SetAllConfigResult

  agent.proto:125

  (message has no fields)

• rpc Up (UpRequest, stream UpStream)

  agent.proto:59

  * Up creates or updates the resources in a stack, returning the actual changes.

  message UpRequest

  agent.proto:204

  • optional int32 parallel = 1

    parallel is the number of resource operations to run in parallel at once (1 for no parallelism). Defaults to unbounded. (default 2147483647)

  • optional string message = 2

    message (optional) to associate with the preview operation

  • optional bool expect_no_changes = 3

    Return an error if any changes occur during this update

  • repeated string replace = 4

    Specify resources to replace

  • repeated string target = 5

    Specify an exclusive list of resource URNs to update

  • optional bool target_dependents = 6

    target_dependents allows updating of dependent targets discovered but not specified in the Target list

  • repeated PolicyPack policy_pack = 8

    // Use the update plan at the given path. optional string plan = 7; Run one or more policy packs as part of this update.

  • optional bool refresh = 9

    refresh will run a refresh before the update.

  • optional bool continue_on_error = 10

    continue_on_error will continue to perform the update operation despite the occurrence of errors.

  message UpStream

  agent.proto:230

  • oneof response

    • google.protobuf.Struct event = 1

      describes a Pulumi engine event, such as a change to a resource or diagnostic message.

    • UpResult result = 2

• rpc WhoAmI (WhoAmIRequest, WhoAmIResult)

  agent.proto:16

  * WhoAmI returns detailed information about the currently logged-in Pulumi identity.

  message WhoAmIRequest

  agent.proto:72

  (message has no fields)

  message WhoAmIResult

  agent.proto:76

  WhoAmIResult contains detailed information about the currently logged-in Pulumi identity.

  • string user = 1

  • repeated string organizations = 2

  • string url = 3

Used in: SetAllConfigRequest

• string key = 1

  The config's key.

• optional bool path = 2

  Parse the key as a paths in a map or list rather than as a raw string.

• oneof v

  • google.protobuf.Value value = 3

    A literal value.

  • ConfigValueFrom value_from = 4

    A value read from the environment or local disk.

• optional bool secret = 5

  Whether the config is a secret.

Used in: ConfigItem

• oneof f

  • string env = 1

    The name of an environment variable to read>

  • string path = 2

    The path to a file to read.

• optional bool json = 3

  Parse value as JSON

Used in: DestroyStream

• string stdout = 1

• string stderr = 2

• optional UpdateSummary summary = 3

• optional string permalink = 4

Used in: UpResult

• bytes value = 1

• bool secret = 2

Used in: PreviewRequest, UpRequest

• string name = 1

Used in: PreviewStream

• string stdout = 1

• string stderr = 2

• optional UpdateSummary summary = 3

• optional string permalink = 4

Describes the cause of the error from Pulumi CLI with structured details.

• int32 code = 1

• string reason = 2

• string message = 3

Used in: RefreshStream

• string stdout = 1

• string stderr = 2

• optional UpdateSummary summary = 3

• optional string permalink = 4

StackSummary is a description of a stack and its current status.

Used in: InfoResult, SelectStackResult

• string name = 1

• optional google.protobuf.Timestamp last_update = 2

• bool update_in_progress = 3

• optional int32 resource_count = 4

• optional string url = 5

Used in: UpStream

• string stdout = 1

• string stderr = 2

• optional UpdateSummary summary = 3

• optional string permalink = 4

• map<string, OutputValue> outputs = 5

Used in: DestroyResult, PreviewResult, RefreshResult, UpResult

• optional google.protobuf.Timestamp start_time = 1

• optional google.protobuf.Timestamp end_time = 2

• string result = 3

• string message = 4