types

type BlueprintDocumentInfo struct {
	// FileSourceScheme is the file source scheme
	// to determine where the blueprint document is located.
	// This can one of the following:
	//
	// `file`: The blueprint document is located on the local file system of the Deploy Engine server.
	// `s3`: The blueprint document is located in an S3 bucket.
	// `gcs`: The blueprint document is located in a Google Cloud Storage bucket.
	// `azureblob`: The blueprint document is located in an Azure Blob Storage container.
	// `https`: The blueprint document is located via a public HTTPS URL.
	//
	// For remote source authentication, the Deploy Engine server will need to be configured
	// with the appropriate credentials to access the remote source.
	// Authentication is not supported `https` sources.
	//
	// If not provided, the default value of `file` will be used.
	FileSourceScheme string `json:"fileSourceScheme"`
	// Directory where the blueprint document is located.
	// For `file` sources, this must be an absolute path to the directory
	// on the local file system of the Deploy Engine server.
	// An example for a `file` source would be `/path/to/blueprint-directory`.
	// For `s3`, `gcs` and `azureblob` sources, this must be the path to the
	// virtual directory where the first path segment is the bucket/container name
	// and the rest of the path is the path to the virtual directory.
	//
	// An example for a remote object storage source would be
	/// `bucket-name/path/to/blueprint-directory`.
	// For `https` sources, this must be the base URL to the blueprint document
	// excluding the scheme.
	// An example for a `https` source would be `example.com/path/to/blueprint-directory`.
	Directory string `json:"directory"`
	// BlueprintFile is the name of the blueprint file to validate.
	//
	// If not provided, the default value of `project.blueprint.yml` will be used.
	BlueprintFile string `json:"blueprintFile"`
	// BlueprintLocationMetadata is a mapping of string keys to
	// scalar values that hold additional information about the location
	// of the blueprint document.
	// For example, this can be used to specify the region of the bucket/container
	// where the blueprint document is located in a cloud storage service.
	BlueprintLocationMetadata map[string]any `json:"blueprintLocationMetadata"`
}

type BlueprintInstanceEvent struct {
	// ID of the blueprint instance event,
	// this is useful for clients that want to persist events
	// to a database or other storage.
	ID string `json:"id"`
	container.DeployEvent
}

type BlueprintInstanceEventType string

type BlueprintInstancePayload struct {
	BlueprintDocumentInfo
	// The ID of the change set to use to deploy the blueprint instance.
	// When deploying blueprint instances,
	// a change set is used instead of the deployment process re-computing the changes
	// that need to be applied.
	// The source blueprint document is still required in addition to a change set to finish
	// resolving substitutions that can only be resolved at deploy time and for deployment
	// orchestration.
	// The source blueprint document is not used to compute changes at the deployment stage.
	ChangeSetID string `json:"changeSetId"`
	// If true, and a new blueprint instance is being created,
	// the creation of the blueprint instance will be treated as a rollback operation
	// for a previously destroyed blueprint instance.
	// If true, and an existing blueprint instance is being updated,
	// the update will be treated as a rollback operation for the previous state.
	Rollback bool `json:"rollback"`
	// Config values for the deployment process
	// that will be used in plugins and passed into the blueprint.
	Config *BlueprintOperationConfig `json:"config"`
}

type BlueprintOperationConfig struct {
	Providers          map[string]map[string]*core.ScalarValue `json:"providers"`
	Transformers       map[string]map[string]*core.ScalarValue `json:"transformers"`
	ContextVariables   map[string]*core.ScalarValue            `json:"contextVariables"`
	BlueprintVariables map[string]*core.ScalarValue            `json:"blueprintVariables"`
}

type BlueprintValidationEvent struct {
	core.Diagnostic
	// ID of the blueprint validation event,
	// this is useful for clients that want to persist events
	// to a database or other storage.
	ID        string `json:"id"`
	Timestamp int64  `json:"timestamp"`
	// End indicates whether or not the event is the last event
	// in the stream.
	End bool `json:"end"`
}

type ChangeStagingEvent struct {
	// ID of the change staging event,
	// this is useful for clients that want to persist events
	// to a database or other storage.
	ID string `json:"id"`
	// ResourceChanges is populated when the change staging event
	// is for when the changes to a resource have been computed.
	ResourceChanges *ResourceChangesEventData `json:"resourceChanges"`
	// ChildChanges is populated when the change staging event
	// is for when the changes to a child blueprint have been computed.
	ChildChanges *ChildChangesEventData `json:"childChanges"`
	// LinkChanges is populated when the change staging event
	// is for when the changes to a link between two resources have been computed.
	LinkChanges *LinkChangesEventData `json:"linkChanges"`
	// CompleteChanges is populated when change staging has been completed,
	// this contains the full set of changes.
	CompleteChanges *CompleteChangesEventData `json:"completeChanges"`
}

type ChangeStagingEventType string

type ChildChangesEventData struct {
	container.ChildChangesMessage
	Timestamp int64 `json:"timestamp"`
}

type CompleteChangesEventData struct {
	Changes   *changes.BlueprintChanges `json:"changes"`
	Timestamp int64                     `json:"timestamp"`
}

type CreateBlueprintValidationPayload struct {
	BlueprintDocumentInfo
	// Config values for the validation process
	// that will be used in plugins and passed into the blueprint.
	Config *BlueprintOperationConfig `json:"config"`
}

type CreateBlueprintValidationQuery struct {
	// CheckBlueprintVars indicates whether or not to check
	// the blueprint variables provided in the request payload
	// as part of the validation process.
	CheckBlueprintVars bool
	// CheckPluginConfig indicates whether or not to check
	// the plugin configuration provided in the request payload
	// as part of the validation process.
	// If set to true, the plugin configuration will be validated
	// against the plugin schemas for each provider and transformer
	// for which configuration is provided in the request.
	CheckPluginConfig bool
}

type CreateChangesetPayload struct {
	BlueprintDocumentInfo
	// The ID of an existing blueprint instance to stage changes for.
	// If this is not provided and an instance name is not provided,
	// a change set for a new blueprint instance deployment will be created.
	// This should be left empty if the `instanceName` field is provided.
	InstanceID string `json:"instanceId"`
	// The user-defined name of an existing blueprint instance to stage changes for.
	// If this is not provided an an instance ID is not provided, a change set for a new
	// blueprint instance deployment will be created.
	// This should be left empty if the `instanceId` field is provided.
	InstanceName string `json:"instanceName"`
	// If true, the change set will be created for a destroy operation.
	// This will only be used if the `instanceId` or `instanceName` fields are provided.
	// If this is not provided, the default value will be false.
	Destroy bool `json:"destroy"`
	// Config values for the change staging process
	// that will be used in plugins and passed into the blueprint.
	Config *BlueprintOperationConfig `json:"config"`
}

type DestroyBlueprintInstancePayload struct {
	// The ID of the change set to use to destroy the blueprint instance.
	// When destroying a blueprint instance,
	// a change set is used instead of the destroy process re-computing the changes
	// that need to be applied.
	ChangeSetID string `json:"changeSetId"`
	// If true, destroying the blueprint instance will be treated as a rollback
	// for the initial deployment of the blueprint instance.
	// This will usually be set to true when rolling back a recent first time
	// deployment that needs to be rolled back due to failure in a parent
	// blueprint instance.
	Rollback bool `json:"rollback"`
	// Config values for the destroy process
	// that will be used in plugins.
	Config *BlueprintOperationConfig `json:"config"`
}

type LinkChangesEventData struct {
	container.LinkChangesMessage
	Timestamp int64 `json:"timestamp"`
}

type ResourceChangesEventData struct {
	container.ResourceChangesMessage
	Timestamp int64 `json:"timestamp"`
}

type StreamErrorMessageEvent struct {
	// ID of the error event,
	// this is useful for clients that want to persist events
	// to a database or other storage.
	ID          string             `json:"id"`
	Message     string             `json:"message"`
	Diagnostics []*core.Diagnostic `json:"diagnostics"`
	Timestamp   int64              `json:"timestamp"`
}