sharedtypesv1

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 6, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ScalarType_name = map[int32]string{
		0: "SCALAR_TYPE_STRING",
		1: "SCALAR_TYPE_INTEGER",
		2: "SCALAR_TYPE_FLOAT",
		3: "SCALAR_TYPE_BOOLEAN",
	}
	ScalarType_value = map[string]int32{
		"SCALAR_TYPE_STRING":  0,
		"SCALAR_TYPE_INTEGER": 1,
		"SCALAR_TYPE_FLOAT":   2,
		"SCALAR_TYPE_BOOLEAN": 3,
	}
)

Enum value maps for ScalarType.

View Source
var (
	FunctionValueType_name = map[int32]string{
		0:  "FUNCTION_VALUE_TYPE_STRING",
		1:  "FUNCTION_VALUE_TYPE_INT32",
		2:  "FUNCTION_VALUE_TYPE_INT64",
		3:  "FUNCTION_VALUE_TYPE_UINT32",
		4:  "FUNCTION_VALUE_TYPE_UINT64",
		5:  "FUNCTION_VALUE_TYPE_FLOAT32",
		6:  "FUNCTION_VALUE_TYPE_FLOAT64",
		7:  "FUNCTION_VALUE_TYPE_BOOL",
		8:  "FUNCTION_VALUE_TYPE_LIST",
		9:  "FUNCTION_VALUE_TYPE_MAP",
		10: "FUNCTION_VALUE_TYPE_OBJECT",
		11: "FUNCTION_VALUE_TYPE_FUNCTION",
		12: "FUNCTION_VALUE_TYPE_ANY",
	}
	FunctionValueType_value = map[string]int32{
		"FUNCTION_VALUE_TYPE_STRING":   0,
		"FUNCTION_VALUE_TYPE_INT32":    1,
		"FUNCTION_VALUE_TYPE_INT64":    2,
		"FUNCTION_VALUE_TYPE_UINT32":   3,
		"FUNCTION_VALUE_TYPE_UINT64":   4,
		"FUNCTION_VALUE_TYPE_FLOAT32":  5,
		"FUNCTION_VALUE_TYPE_FLOAT64":  6,
		"FUNCTION_VALUE_TYPE_BOOL":     7,
		"FUNCTION_VALUE_TYPE_LIST":     8,
		"FUNCTION_VALUE_TYPE_MAP":      9,
		"FUNCTION_VALUE_TYPE_OBJECT":   10,
		"FUNCTION_VALUE_TYPE_FUNCTION": 11,
		"FUNCTION_VALUE_TYPE_ANY":      12,
	}
)

Enum value maps for FunctionValueType.

View Source
var (
	ResourceStatus_name = map[int32]string{
		0:  "RESOURCE_STATUS_UNKNOWN",
		1:  "RESOURCE_STATUS_CREATING",
		2:  "RESOURCE_STATUS_CREATED",
		3:  "RESOURCE_STATUS_CREATE_FAILED",
		4:  "RESOURCE_STATUS_DESTROYING",
		5:  "RESOURCE_STATUS_DESTROYED",
		6:  "RESOURCE_STATUS_DESTROY_FAILED",
		7:  "RESOURCE_STATUS_UPDATING",
		8:  "RESOURCE_STATUS_UPDATED",
		9:  "RESOURCE_STATUS_UPDATE_FAILED",
		10: "RESOURCE_STATUS_ROLLING_BACK",
		11: "RESOURCE_STATUS_ROLLBACK_FAILED",
		12: "RESOURCE_STATUS_ROLLBACK_COMPLETE",
		13: "RESOURCE_STATUS_CREATE_INTERRUPTED",
		14: "RESOURCE_STATUS_UPDATE_INTERRUPTED",
		15: "RESOURCE_STATUS_DESTROY_INTERRUPTED",
	}
	ResourceStatus_value = map[string]int32{
		"RESOURCE_STATUS_UNKNOWN":             0,
		"RESOURCE_STATUS_CREATING":            1,
		"RESOURCE_STATUS_CREATED":             2,
		"RESOURCE_STATUS_CREATE_FAILED":       3,
		"RESOURCE_STATUS_DESTROYING":          4,
		"RESOURCE_STATUS_DESTROYED":           5,
		"RESOURCE_STATUS_DESTROY_FAILED":      6,
		"RESOURCE_STATUS_UPDATING":            7,
		"RESOURCE_STATUS_UPDATED":             8,
		"RESOURCE_STATUS_UPDATE_FAILED":       9,
		"RESOURCE_STATUS_ROLLING_BACK":        10,
		"RESOURCE_STATUS_ROLLBACK_FAILED":     11,
		"RESOURCE_STATUS_ROLLBACK_COMPLETE":   12,
		"RESOURCE_STATUS_CREATE_INTERRUPTED":  13,
		"RESOURCE_STATUS_UPDATE_INTERRUPTED":  14,
		"RESOURCE_STATUS_DESTROY_INTERRUPTED": 15,
	}
)

Enum value maps for ResourceStatus.

View Source
var (
	PreciseResourceStatus_name = map[int32]string{
		0:  "PRECISE_RESOURCE_STATUS_UNKNOWN",
		1:  "PRECISE_RESOURCE_STATUS_CREATING",
		2:  "PRECISE_RESOURCE_STATUS_CONFIG_COMPLETE",
		3:  "PRECISE_RESOURCE_STATUS_CREATED",
		4:  "PRECISE_RESOURCE_STATUS_CREATE_FAILED",
		5:  "PRECISE_RESOURCE_STATUS_CREATE_ROLLING_BACK",
		6:  "PRECISE_RESOURCE_STATUS_CREATE_ROLLBACK_FAILED",
		7:  "PRECISE_RESOURCE_STATUS_CREATE_ROLLBACK_COMPLETE",
		8:  "PRECISE_RESOURCE_STATUS_DESTROYING",
		9:  "PRECISE_RESOURCE_STATUS_DESTROYED",
		10: "PRECISE_RESOURCE_STATUS_DESTROY_FAILED",
		11: "PRECISE_RESOURCE_STATUS_DESTROY_ROLLING_BACK",
		12: "PRECISE_RESOURCE_STATUS_DESTROY_ROLLBACK_FAILED",
		13: "PRECISE_RESOURCE_STATUS_DESTROY_ROLLBACK_CONFIG_COMPLETE",
		14: "PRECISE_RESOURCE_STATUS_DESTROY_ROLLBACK_COMPLETE",
		15: "PRECISE_RESOURCE_STATUS_UPDATING",
		16: "PRECISE_RESOURCE_STATUS_UPDATE_CONFIG_COMPLETE",
		17: "PRECISE_RESOURCE_STATUS_UPDATED",
		18: "PRECISE_RESOURCE_STATUS_UPDATE_FAILED",
		19: "PRECISE_RESOURCE_STATUS_UPDATE_ROLLING_BACK",
		20: "PRECISE_RESOURCE_STATUS_UPDATE_ROLLBACK_FAILED",
		21: "PRECISE_RESOURCE_STATUS_UPDATE_ROLLBACK_CONFIG_COMPLETE",
		22: "PRECISE_RESOURCE_STATUS_UPDATE_ROLLBACK_COMPLETE",
		23: "PRECISE_RESOURCE_STATUS_CREATE_INTERRUPTED",
		24: "PRECISE_RESOURCE_STATUS_UPDATE_INTERRUPTED",
		25: "PRECISE_RESOURCE_STATUS_DESTROY_INTERRUPTED",
	}
	PreciseResourceStatus_value = map[string]int32{
		"PRECISE_RESOURCE_STATUS_UNKNOWN":                          0,
		"PRECISE_RESOURCE_STATUS_CREATING":                         1,
		"PRECISE_RESOURCE_STATUS_CONFIG_COMPLETE":                  2,
		"PRECISE_RESOURCE_STATUS_CREATED":                          3,
		"PRECISE_RESOURCE_STATUS_CREATE_FAILED":                    4,
		"PRECISE_RESOURCE_STATUS_CREATE_ROLLING_BACK":              5,
		"PRECISE_RESOURCE_STATUS_CREATE_ROLLBACK_FAILED":           6,
		"PRECISE_RESOURCE_STATUS_CREATE_ROLLBACK_COMPLETE":         7,
		"PRECISE_RESOURCE_STATUS_DESTROYING":                       8,
		"PRECISE_RESOURCE_STATUS_DESTROYED":                        9,
		"PRECISE_RESOURCE_STATUS_DESTROY_FAILED":                   10,
		"PRECISE_RESOURCE_STATUS_DESTROY_ROLLING_BACK":             11,
		"PRECISE_RESOURCE_STATUS_DESTROY_ROLLBACK_FAILED":          12,
		"PRECISE_RESOURCE_STATUS_DESTROY_ROLLBACK_CONFIG_COMPLETE": 13,
		"PRECISE_RESOURCE_STATUS_DESTROY_ROLLBACK_COMPLETE":        14,
		"PRECISE_RESOURCE_STATUS_UPDATING":                         15,
		"PRECISE_RESOURCE_STATUS_UPDATE_CONFIG_COMPLETE":           16,
		"PRECISE_RESOURCE_STATUS_UPDATED":                          17,
		"PRECISE_RESOURCE_STATUS_UPDATE_FAILED":                    18,
		"PRECISE_RESOURCE_STATUS_UPDATE_ROLLING_BACK":              19,
		"PRECISE_RESOURCE_STATUS_UPDATE_ROLLBACK_FAILED":           20,
		"PRECISE_RESOURCE_STATUS_UPDATE_ROLLBACK_CONFIG_COMPLETE":  21,
		"PRECISE_RESOURCE_STATUS_UPDATE_ROLLBACK_COMPLETE":         22,
		"PRECISE_RESOURCE_STATUS_CREATE_INTERRUPTED":               23,
		"PRECISE_RESOURCE_STATUS_UPDATE_INTERRUPTED":               24,
		"PRECISE_RESOURCE_STATUS_DESTROY_INTERRUPTED":              25,
	}
)

Enum value maps for PreciseResourceStatus.

View Source
var (
	DiagnosticLevel_name = map[int32]string{
		0: "DIAGNOSTIC_LEVEL_NONE",
		1: "DIAGNOSTIC_LEVEL_ERROR",
		2: "DIAGNOSTIC_LEVEL_WARNING",
		3: "DIAGNOSTIC_LEVEL_INFO",
	}
	DiagnosticLevel_value = map[string]int32{
		"DIAGNOSTIC_LEVEL_NONE":    0,
		"DIAGNOSTIC_LEVEL_ERROR":   1,
		"DIAGNOSTIC_LEVEL_WARNING": 2,
		"DIAGNOSTIC_LEVEL_INFO":    3,
	}
)

Enum value maps for DiagnosticLevel.

View Source
var (
	ColumnAccuracy_name = map[int32]string{
		0: "COLUMN_ACCURACY_NONE",
		1: "COLUMN_ACCURACY_EXACT",
		2: "COLUMN_ACCURACY_APPROXIMATE",
	}
	ColumnAccuracy_value = map[string]int32{
		"COLUMN_ACCURACY_NONE":        0,
		"COLUMN_ACCURACY_EXACT":       1,
		"COLUMN_ACCURACY_APPROXIMATE": 2,
	}
)

Enum value maps for ColumnAccuracy.

View Source
var (
	TaggingSupport_name = map[int32]string{
		0: "TAGGING_SUPPORT_NONE",
		1: "TAGGING_SUPPORT_FULL",
		2: "TAGGING_SUPPORT_LABELS",
	}
	TaggingSupport_value = map[string]int32{
		"TAGGING_SUPPORT_NONE":   0,
		"TAGGING_SUPPORT_FULL":   1,
		"TAGGING_SUPPORT_LABELS": 2,
	}
)

Enum value maps for TaggingSupport.

View Source
var (
	ErrorCode_name = map[int32]string{
		0: "ERROR_CODE_UNEXPECTED",
		1: "ERROR_CODE_TRANSIENT",
		2: "ERROR_CODE_BAD_INPUT",
	}
	ErrorCode_value = map[string]int32{
		"ERROR_CODE_UNEXPECTED": 0,
		"ERROR_CODE_TRANSIENT":  1,
		"ERROR_CODE_BAD_INPUT":  2,
	}
)

Enum value maps for ErrorCode.

View Source
var File_plugin_framework_sharedtypesv1_types_proto protoreflect.FileDescriptor

Functions

func FromPBResourceTypes

func FromPBResourceTypes(resourceTypes []*ResourceType) []string

FromPBResourceTypes converts a slice of protobuf ResourceType to a slice of string for a gRPC plugin response.

func ToCoreDiagnostics

func ToCoreDiagnostics(diagnostics []*Diagnostic) ([]*core.Diagnostic, error)

ToCoreDiagnostics converts a slice of protobuf Diagnostics to a slice of core Diagnostics for a gRPC plugin response.

Types

type BlueprintParams

type BlueprintParams struct {

	// Configuration parameters for multiple providers.
	// Keys are expected to be in the format `{providerNamespace}::{variableName}`.
	ProviderConfigVariables map[string]*schemapb.ScalarValue `` /* 199-byte string literal not displayed */
	// Configuration parameters for multiple transformers.
	// Keys are expected to be in the format `{transformerNamespace}::{variableName}`.
	TransformerConfigVariables map[string]*schemapb.ScalarValue `` /* 208-byte string literal not displayed */
	// Context-wide variable for the current deploy engine run.
	ContextVariables map[string]*schemapb.ScalarValue `` /* 176-byte string literal not displayed */
	// Variables for the current blueprint.
	BlueprintVariables map[string]*schemapb.ScalarValue `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

BlueprintParams holds environment and blueprint configuration to be used for function implementations.

func (*BlueprintParams) Descriptor deprecated

func (*BlueprintParams) Descriptor() ([]byte, []int)

Deprecated: Use BlueprintParams.ProtoReflect.Descriptor instead.

func (*BlueprintParams) GetBlueprintVariables

func (x *BlueprintParams) GetBlueprintVariables() map[string]*schemapb.ScalarValue

func (*BlueprintParams) GetContextVariables

func (x *BlueprintParams) GetContextVariables() map[string]*schemapb.ScalarValue

func (*BlueprintParams) GetProviderConfigVariables

func (x *BlueprintParams) GetProviderConfigVariables() map[string]*schemapb.ScalarValue

func (*BlueprintParams) GetTransformerConfigVariables

func (x *BlueprintParams) GetTransformerConfigVariables() map[string]*schemapb.ScalarValue

func (*BlueprintParams) ProtoMessage

func (*BlueprintParams) ProtoMessage()

func (*BlueprintParams) ProtoReflect

func (x *BlueprintParams) ProtoReflect() protoreflect.Message

func (*BlueprintParams) Reset

func (x *BlueprintParams) Reset()

func (*BlueprintParams) String

func (x *BlueprintParams) String() string

type CanLinkTo

type CanLinkTo struct {
	ResourceTypes []*ResourceType `protobuf:"bytes,1,rep,name=resource_types,json=resourceTypes" json:"resource_types,omitempty"`
	// contains filtered or unexported fields
}

CanLinkTo holds a list of resource types that a given resource type can link to.

func (*CanLinkTo) Descriptor deprecated

func (*CanLinkTo) Descriptor() ([]byte, []int)

Deprecated: Use CanLinkTo.ProtoReflect.Descriptor instead.

func (*CanLinkTo) GetResourceTypes

func (x *CanLinkTo) GetResourceTypes() []*ResourceType

func (*CanLinkTo) ProtoMessage

func (*CanLinkTo) ProtoMessage()

func (*CanLinkTo) ProtoReflect

func (x *CanLinkTo) ProtoReflect() protoreflect.Message

func (*CanLinkTo) Reset

func (x *CanLinkTo) Reset()

func (*CanLinkTo) String

func (x *CanLinkTo) String() string

type Changes

type Changes struct {

	// Provides a new version of the spec and schema for which variable
	// substitution has been applied so the deploy phase has everything
	// it needs to deploy the resource.
	AppliedResourceInfo *ResourceInfo  `protobuf:"bytes,1,opt,name=applied_resource_info,json=appliedResourceInfo" json:"applied_resource_info,omitempty"`
	MustRecreate        bool           `protobuf:"varint,2,opt,name=must_recreate,json=mustRecreate" json:"must_recreate,omitempty"`
	ModifiedFields      []*FieldChange `protobuf:"bytes,3,rep,name=modified_fields,json=modifiedFields" json:"modified_fields,omitempty"`
	NewFields           []*FieldChange `protobuf:"bytes,4,rep,name=new_fields,json=newFields" json:"new_fields,omitempty"`
	RemovedFields       []string       `protobuf:"bytes,5,rep,name=removed_fields,json=removedFields" json:"removed_fields,omitempty"`
	UnchangedFields     []string       `protobuf:"bytes,6,rep,name=unchanged_fields,json=unchangedFields" json:"unchanged_fields,omitempty"`
	// A list of field paths that are computed at deploy time.
	// This is primarily useful to give fast access to information
	// about which fields are computed without having to inspect
	// the spec schema in link implementations.
	ComputedFields []string `protobuf:"bytes,7,rep,name=computed_fields,json=computedFields" json:"computed_fields,omitempty"`
	// A list of field names for which changes will be known when the host
	// blueprint is deployed.
	FieldChangesKnownOnDeploy []string `` /* 135-byte string literal not displayed */
	// Specifies whether the condition
	// for the resource will be known when the host blueprint is deployed.
	// When a condition makes use of items in the blueprint that are not resolved
	// until deployment, whether the resource will be deployed or not
	// cannot be known during the change staging phase.
	ConditionKnownOnDeploy bool `protobuf:"varint,9,opt,name=condition_known_on_deploy,json=conditionKnownOnDeploy" json:"condition_known_on_deploy,omitempty"`
	// A mapping of the linked to resource name
	// to the link changes representing the new links that will be created.
	NewOutboundLinks map[string]*LinkChanges `` /* 179-byte string literal not displayed */
	// A mapping of the linked to resource name to any changes
	// that will be made to existing links.
	// The key is of the form `{resourceA}::{resourceB}`.
	OutboundLinkChanges map[string]*LinkChanges `` /* 188-byte string literal not displayed */
	// A list of link identifiers that will be removed.
	// The form of the link identifier is `{resourceA}::{resourceB}`.
	RemovedOutboundLinks []string `protobuf:"bytes,12,rep,name=removed_outbound_links,json=removedOutboundLinks" json:"removed_outbound_links,omitempty"`
	// contains filtered or unexported fields
}

Changes provides a set of modified fields along with a version of the resource schema (includes metadata labels and annotations) and spec that has already had all it's variables substituted.

func (*Changes) Descriptor deprecated

func (*Changes) Descriptor() ([]byte, []int)

Deprecated: Use Changes.ProtoReflect.Descriptor instead.

func (*Changes) GetAppliedResourceInfo

func (x *Changes) GetAppliedResourceInfo() *ResourceInfo

func (*Changes) GetComputedFields

func (x *Changes) GetComputedFields() []string

func (*Changes) GetConditionKnownOnDeploy

func (x *Changes) GetConditionKnownOnDeploy() bool

func (*Changes) GetFieldChangesKnownOnDeploy

func (x *Changes) GetFieldChangesKnownOnDeploy() []string

func (*Changes) GetModifiedFields

func (x *Changes) GetModifiedFields() []*FieldChange

func (*Changes) GetMustRecreate

func (x *Changes) GetMustRecreate() bool

func (*Changes) GetNewFields

func (x *Changes) GetNewFields() []*FieldChange
func (x *Changes) GetNewOutboundLinks() map[string]*LinkChanges

func (*Changes) GetOutboundLinkChanges

func (x *Changes) GetOutboundLinkChanges() map[string]*LinkChanges

func (*Changes) GetRemovedFields

func (x *Changes) GetRemovedFields() []string
func (x *Changes) GetRemovedOutboundLinks() []string

func (*Changes) GetUnchangedFields

func (x *Changes) GetUnchangedFields() []string

func (*Changes) ProtoMessage

func (*Changes) ProtoMessage()

func (*Changes) ProtoReflect

func (x *Changes) ProtoReflect() protoreflect.Message

func (*Changes) Reset

func (x *Changes) Reset()

func (*Changes) String

func (x *Changes) String() string

type ColumnAccuracy

type ColumnAccuracy int32

ColumnAccuracy is an enum for the accuracy of a column location in a source blueprint.

const (
	// protobuf enums must have a zero value, so we need a NONE value
	// here.
	// ColumnAccuracy starts at 1 as per the Blueprint framework.
	ColumnAccuracy_COLUMN_ACCURACY_NONE ColumnAccuracy = 0
	// Indicates that the column is accurate.
	ColumnAccuracy_COLUMN_ACCURACY_EXACT ColumnAccuracy = 1
	// Indicates that the column is approximate.
	ColumnAccuracy_COLUMN_ACCURACY_APPROXIMATE ColumnAccuracy = 2
)

func (ColumnAccuracy) Descriptor

func (ColumnAccuracy) Enum

func (x ColumnAccuracy) Enum() *ColumnAccuracy

func (ColumnAccuracy) EnumDescriptor deprecated

func (ColumnAccuracy) EnumDescriptor() ([]byte, []int)

Deprecated: Use ColumnAccuracy.Descriptor instead.

func (ColumnAccuracy) Number

func (ColumnAccuracy) String

func (x ColumnAccuracy) String() string

func (ColumnAccuracy) Type

type ConfigDefinition

type ConfigDefinition struct {
	Fields                map[string]*ConfigFieldDefinition `` /* 132-byte string literal not displayed */
	AllowAdditionalFields bool                              `protobuf:"varint,2,opt,name=allow_additional_fields,json=allowAdditionalFields" json:"allow_additional_fields,omitempty"`
	// contains filtered or unexported fields
}

ConfigDefinition contains a detailed definition (schema) of the configuration required for a provider or transformer plugin.

func (*ConfigDefinition) Descriptor deprecated

func (*ConfigDefinition) Descriptor() ([]byte, []int)

Deprecated: Use ConfigDefinition.ProtoReflect.Descriptor instead.

func (*ConfigDefinition) GetAllowAdditionalFields

func (x *ConfigDefinition) GetAllowAdditionalFields() bool

func (*ConfigDefinition) GetFields

func (x *ConfigDefinition) GetFields() map[string]*ConfigFieldDefinition

func (*ConfigDefinition) ProtoMessage

func (*ConfigDefinition) ProtoMessage()

func (*ConfigDefinition) ProtoReflect

func (x *ConfigDefinition) ProtoReflect() protoreflect.Message

func (*ConfigDefinition) Reset

func (x *ConfigDefinition) Reset()

func (*ConfigDefinition) String

func (x *ConfigDefinition) String() string

type ConfigDefinitionResponse

type ConfigDefinitionResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*ConfigDefinitionResponse_ConfigDefinition
	//	*ConfigDefinitionResponse_ErrorResponse
	Response isConfigDefinitionResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

ConfigDefinitionResponse contains the response for requesting the configuration definition for a provider or transformer plugin.

func (*ConfigDefinitionResponse) Descriptor deprecated

func (*ConfigDefinitionResponse) Descriptor() ([]byte, []int)

Deprecated: Use ConfigDefinitionResponse.ProtoReflect.Descriptor instead.

func (*ConfigDefinitionResponse) GetConfigDefinition

func (x *ConfigDefinitionResponse) GetConfigDefinition() *ConfigDefinition

func (*ConfigDefinitionResponse) GetErrorResponse

func (x *ConfigDefinitionResponse) GetErrorResponse() *ErrorResponse

func (*ConfigDefinitionResponse) GetResponse

func (x *ConfigDefinitionResponse) GetResponse() isConfigDefinitionResponse_Response

func (*ConfigDefinitionResponse) ProtoMessage

func (*ConfigDefinitionResponse) ProtoMessage()

func (*ConfigDefinitionResponse) ProtoReflect

func (x *ConfigDefinitionResponse) ProtoReflect() protoreflect.Message

func (*ConfigDefinitionResponse) Reset

func (x *ConfigDefinitionResponse) Reset()

func (*ConfigDefinitionResponse) String

func (x *ConfigDefinitionResponse) String() string

type ConfigDefinitionResponse_ConfigDefinition

type ConfigDefinitionResponse_ConfigDefinition struct {
	ConfigDefinition *ConfigDefinition `protobuf:"bytes,1,opt,name=config_definition,json=configDefinition,oneof"`
}

type ConfigDefinitionResponse_ErrorResponse

type ConfigDefinitionResponse_ErrorResponse struct {
	ErrorResponse *ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type ConfigFieldDefinition

type ConfigFieldDefinition struct {
	Type          ScalarType              `protobuf:"varint,1,opt,name=type,enum=sharedtypesv1.ScalarType" json:"type,omitempty"`
	Label         string                  `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	Description   string                  `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	DefaultValue  *schemapb.ScalarValue   `protobuf:"bytes,4,opt,name=default_value,json=defaultValue" json:"default_value,omitempty"`
	AllowedValues []*schemapb.ScalarValue `protobuf:"bytes,5,rep,name=allowed_values,json=allowedValues" json:"allowed_values,omitempty"`
	Secret        bool                    `protobuf:"varint,6,opt,name=secret" json:"secret,omitempty"`
	Examples      []*schemapb.ScalarValue `protobuf:"bytes,7,rep,name=examples" json:"examples,omitempty"`
	Required      bool                    `protobuf:"varint,8,opt,name=required" json:"required,omitempty"`
	// contains filtered or unexported fields
}

ConfigFieldDefinition represents a field in a configuration definition for a provider or transformer plugin.

func (*ConfigFieldDefinition) Descriptor deprecated

func (*ConfigFieldDefinition) Descriptor() ([]byte, []int)

Deprecated: Use ConfigFieldDefinition.ProtoReflect.Descriptor instead.

func (*ConfigFieldDefinition) GetAllowedValues

func (x *ConfigFieldDefinition) GetAllowedValues() []*schemapb.ScalarValue

func (*ConfigFieldDefinition) GetDefaultValue

func (x *ConfigFieldDefinition) GetDefaultValue() *schemapb.ScalarValue

func (*ConfigFieldDefinition) GetDescription

func (x *ConfigFieldDefinition) GetDescription() string

func (*ConfigFieldDefinition) GetExamples

func (x *ConfigFieldDefinition) GetExamples() []*schemapb.ScalarValue

func (*ConfigFieldDefinition) GetLabel

func (x *ConfigFieldDefinition) GetLabel() string

func (*ConfigFieldDefinition) GetRequired

func (x *ConfigFieldDefinition) GetRequired() bool

func (*ConfigFieldDefinition) GetSecret

func (x *ConfigFieldDefinition) GetSecret() bool

func (*ConfigFieldDefinition) GetType

func (x *ConfigFieldDefinition) GetType() ScalarType

func (*ConfigFieldDefinition) ProtoMessage

func (*ConfigFieldDefinition) ProtoMessage()

func (*ConfigFieldDefinition) ProtoReflect

func (x *ConfigFieldDefinition) ProtoReflect() protoreflect.Message

func (*ConfigFieldDefinition) Reset

func (x *ConfigFieldDefinition) Reset()

func (*ConfigFieldDefinition) String

func (x *ConfigFieldDefinition) String() string

type DeployResourceCompleteResponse

type DeployResourceCompleteResponse struct {

	// A mapping of computed field paths to their values.
	// Examples of computed fields are the ARN of an AWS Lambda function
	// or the ID of a Google Cloud Storage bucket.
	// Some examples of valid computed field paths are:
	// - `spec.arn`
	// - `spec.id`
	// - `spec.arns[0]`
	// - `spec.identifiers["id.v1"]`
	// - `spec["identifiers.1"].arn`
	//
	// The computed fields will be injected into the final resource state that
	// will be persisted as a part of the blueprint instance state.
	ComputedFieldValues map[string]*schemapb.MappingNode `` /* 187-byte string literal not displayed */
	// contains filtered or unexported fields
}

DeployResourceCompleteResponse is the response returned by the provider plugin when a resource has been deployed. This should contain any computed fields that are known after the resource has been deployed.

func (*DeployResourceCompleteResponse) Descriptor deprecated

func (*DeployResourceCompleteResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeployResourceCompleteResponse.ProtoReflect.Descriptor instead.

func (*DeployResourceCompleteResponse) GetComputedFieldValues

func (x *DeployResourceCompleteResponse) GetComputedFieldValues() map[string]*schemapb.MappingNode

func (*DeployResourceCompleteResponse) ProtoMessage

func (*DeployResourceCompleteResponse) ProtoMessage()

func (*DeployResourceCompleteResponse) ProtoReflect

func (*DeployResourceCompleteResponse) Reset

func (x *DeployResourceCompleteResponse) Reset()

func (*DeployResourceCompleteResponse) String

type DeployResourceRequest

type DeployResourceRequest struct {

	// The type of resource to carry out an action on or retrieve
	// some information about.
	ResourceType *ResourceType `protobuf:"bytes,1,opt,name=resource_type,json=resourceType" json:"resource_type,omitempty"`
	// The ID of the host making the request
	// to the provider.
	HostId       string   `protobuf:"bytes,2,opt,name=host_id,json=hostId" json:"host_id,omitempty"`
	InstanceId   string   `protobuf:"bytes,3,opt,name=instance_id,json=instanceId" json:"instance_id,omitempty"`
	InstanceName string   `protobuf:"bytes,4,opt,name=instance_name,json=instanceName" json:"instance_name,omitempty"`
	ResourceId   string   `protobuf:"bytes,5,opt,name=resource_id,json=resourceId" json:"resource_id,omitempty"`
	Changes      *Changes `protobuf:"bytes,6,opt,name=changes" json:"changes,omitempty"`
	// Runtime configuration for the current environment
	// specific to the current provider.
	Context *ProviderContext `protobuf:"bytes,7,opt,name=context" json:"context,omitempty"`
	// contains filtered or unexported fields
}

DeployResourceRequest provides the input data needed for a resource to be deployed.

func (*DeployResourceRequest) Descriptor deprecated

func (*DeployResourceRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeployResourceRequest.ProtoReflect.Descriptor instead.

func (*DeployResourceRequest) GetChanges

func (x *DeployResourceRequest) GetChanges() *Changes

func (*DeployResourceRequest) GetContext

func (x *DeployResourceRequest) GetContext() *ProviderContext

func (*DeployResourceRequest) GetHostId

func (x *DeployResourceRequest) GetHostId() string

func (*DeployResourceRequest) GetInstanceId

func (x *DeployResourceRequest) GetInstanceId() string

func (*DeployResourceRequest) GetInstanceName

func (x *DeployResourceRequest) GetInstanceName() string

func (*DeployResourceRequest) GetResourceId

func (x *DeployResourceRequest) GetResourceId() string

func (*DeployResourceRequest) GetResourceType

func (x *DeployResourceRequest) GetResourceType() *ResourceType

func (*DeployResourceRequest) ProtoMessage

func (*DeployResourceRequest) ProtoMessage()

func (*DeployResourceRequest) ProtoReflect

func (x *DeployResourceRequest) ProtoReflect() protoreflect.Message

func (*DeployResourceRequest) Reset

func (x *DeployResourceRequest) Reset()

func (*DeployResourceRequest) String

func (x *DeployResourceRequest) String() string

type DeployResourceResponse

type DeployResourceResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*DeployResourceResponse_CompleteResponse
	//	*DeployResourceResponse_ErrorResponse
	Response isDeployResourceResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

DeployResourceResponse is the response containing the result of deploying a resource.

func (*DeployResourceResponse) Descriptor deprecated

func (*DeployResourceResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeployResourceResponse.ProtoReflect.Descriptor instead.

func (*DeployResourceResponse) GetCompleteResponse

func (x *DeployResourceResponse) GetCompleteResponse() *DeployResourceCompleteResponse

func (*DeployResourceResponse) GetErrorResponse

func (x *DeployResourceResponse) GetErrorResponse() *ErrorResponse

func (*DeployResourceResponse) GetResponse

func (x *DeployResourceResponse) GetResponse() isDeployResourceResponse_Response

func (*DeployResourceResponse) ProtoMessage

func (*DeployResourceResponse) ProtoMessage()

func (*DeployResourceResponse) ProtoReflect

func (x *DeployResourceResponse) ProtoReflect() protoreflect.Message

func (*DeployResourceResponse) Reset

func (x *DeployResourceResponse) Reset()

func (*DeployResourceResponse) String

func (x *DeployResourceResponse) String() string

type DeployResourceResponse_CompleteResponse

type DeployResourceResponse_CompleteResponse struct {
	CompleteResponse *DeployResourceCompleteResponse `protobuf:"bytes,1,opt,name=complete_response,json=completeResponse,oneof"`
}

type DeployResourceResponse_ErrorResponse

type DeployResourceResponse_ErrorResponse struct {
	ErrorResponse *ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type DestroyResourceRequest

type DestroyResourceRequest struct {
	ResourceType *ResourceType `protobuf:"bytes,1,opt,name=resource_type,json=resourceType" json:"resource_type,omitempty"`
	// The ID of the host making the request
	// to the provider.
	HostId        string           `protobuf:"bytes,2,opt,name=host_id,json=hostId" json:"host_id,omitempty"`
	InstanceId    string           `protobuf:"bytes,3,opt,name=instance_id,json=instanceId" json:"instance_id,omitempty"`
	InstanceName  string           `protobuf:"bytes,4,opt,name=instance_name,json=instanceName" json:"instance_name,omitempty"`
	ResourceId    string           `protobuf:"bytes,5,opt,name=resource_id,json=resourceId" json:"resource_id,omitempty"`
	ResourceState *ResourceState   `protobuf:"bytes,6,opt,name=resource_state,json=resourceState" json:"resource_state,omitempty"`
	Context       *ProviderContext `protobuf:"bytes,7,opt,name=context" json:"context,omitempty"`
	// contains filtered or unexported fields
}

DestroyResourceRequest is the request that contains the input data needed to destroy a resource instance.

func (*DestroyResourceRequest) Descriptor deprecated

func (*DestroyResourceRequest) Descriptor() ([]byte, []int)

Deprecated: Use DestroyResourceRequest.ProtoReflect.Descriptor instead.

func (*DestroyResourceRequest) GetContext

func (x *DestroyResourceRequest) GetContext() *ProviderContext

func (*DestroyResourceRequest) GetHostId

func (x *DestroyResourceRequest) GetHostId() string

func (*DestroyResourceRequest) GetInstanceId

func (x *DestroyResourceRequest) GetInstanceId() string

func (*DestroyResourceRequest) GetInstanceName

func (x *DestroyResourceRequest) GetInstanceName() string

func (*DestroyResourceRequest) GetResourceId

func (x *DestroyResourceRequest) GetResourceId() string

func (*DestroyResourceRequest) GetResourceState

func (x *DestroyResourceRequest) GetResourceState() *ResourceState

func (*DestroyResourceRequest) GetResourceType

func (x *DestroyResourceRequest) GetResourceType() *ResourceType

func (*DestroyResourceRequest) ProtoMessage

func (*DestroyResourceRequest) ProtoMessage()

func (*DestroyResourceRequest) ProtoReflect

func (x *DestroyResourceRequest) ProtoReflect() protoreflect.Message

func (*DestroyResourceRequest) Reset

func (x *DestroyResourceRequest) Reset()

func (*DestroyResourceRequest) String

func (x *DestroyResourceRequest) String() string

type DestroyResourceResponse

type DestroyResourceResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*DestroyResourceResponse_Result
	//	*DestroyResourceResponse_ErrorResponse
	Response isDestroyResourceResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

DestroyResourceResponse is the response containing the result of destroying a resource.

func (*DestroyResourceResponse) Descriptor deprecated

func (*DestroyResourceResponse) Descriptor() ([]byte, []int)

Deprecated: Use DestroyResourceResponse.ProtoReflect.Descriptor instead.

func (*DestroyResourceResponse) GetErrorResponse

func (x *DestroyResourceResponse) GetErrorResponse() *ErrorResponse

func (*DestroyResourceResponse) GetResponse

func (x *DestroyResourceResponse) GetResponse() isDestroyResourceResponse_Response

func (*DestroyResourceResponse) GetResult

func (*DestroyResourceResponse) ProtoMessage

func (*DestroyResourceResponse) ProtoMessage()

func (*DestroyResourceResponse) ProtoReflect

func (x *DestroyResourceResponse) ProtoReflect() protoreflect.Message

func (*DestroyResourceResponse) Reset

func (x *DestroyResourceResponse) Reset()

func (*DestroyResourceResponse) String

func (x *DestroyResourceResponse) String() string

type DestroyResourceResponse_ErrorResponse

type DestroyResourceResponse_ErrorResponse struct {
	ErrorResponse *ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type DestroyResourceResponse_Result

type DestroyResourceResponse_Result struct {
	Result *DestroyResourceResult `protobuf:"bytes,1,opt,name=result,oneof"`
}

type DestroyResourceResult

type DestroyResourceResult struct {
	Destroyed bool `protobuf:"varint,1,opt,name=destroyed" json:"destroyed,omitempty"`
	// contains filtered or unexported fields
}

DestroyResourceResult contains the result of destroying a resource.

func (*DestroyResourceResult) Descriptor deprecated

func (*DestroyResourceResult) Descriptor() ([]byte, []int)

Deprecated: Use DestroyResourceResult.ProtoReflect.Descriptor instead.

func (*DestroyResourceResult) GetDestroyed

func (x *DestroyResourceResult) GetDestroyed() bool

func (*DestroyResourceResult) ProtoMessage

func (*DestroyResourceResult) ProtoMessage()

func (*DestroyResourceResult) ProtoReflect

func (x *DestroyResourceResult) ProtoReflect() protoreflect.Message

func (*DestroyResourceResult) Reset

func (x *DestroyResourceResult) Reset()

func (*DestroyResourceResult) String

func (x *DestroyResourceResult) String() string

type Diagnostic

type Diagnostic struct {

	// The level of this diagnostic.
	Level DiagnosticLevel `protobuf:"varint,1,opt,name=level,enum=sharedtypesv1.DiagnosticLevel" json:"level,omitempty"`
	// The message of this diagnostic.
	Message string `protobuf:"bytes,2,opt,name=message" json:"message,omitempty"`
	// An optional text range in the source blueprint
	// that the diagnostic applies to.
	// This will only be present when the source blueprint
	// is YAML and the plugin can extract this information
	// from the resource schema.
	Range *DiagnosticRange `protobuf:"bytes,3,opt,name=range" json:"range,omitempty"`
	// Additional context for the diagnostic, usually present for errors
	// to create more user-friendly action-oriented messages.
	Context *DiagnosticContext `protobuf:"bytes,4,opt,name=context" json:"context,omitempty"`
	// contains filtered or unexported fields
}

Diagnostic provides error, warning or informational diagnostic for a blueprint.

func ToPBDiagnostics

func ToPBDiagnostics(diagnostics []*core.Diagnostic) ([]*Diagnostic, error)

ToPBDiagnostics converts a slice of core Diagnostics to a slice of protobuf Diagnostics for a gRPC plugin response.

func (*Diagnostic) Descriptor deprecated

func (*Diagnostic) Descriptor() ([]byte, []int)

Deprecated: Use Diagnostic.ProtoReflect.Descriptor instead.

func (*Diagnostic) GetContext

func (x *Diagnostic) GetContext() *DiagnosticContext

func (*Diagnostic) GetLevel

func (x *Diagnostic) GetLevel() DiagnosticLevel

func (*Diagnostic) GetMessage

func (x *Diagnostic) GetMessage() string

func (*Diagnostic) GetRange

func (x *Diagnostic) GetRange() *DiagnosticRange

func (*Diagnostic) ProtoMessage

func (*Diagnostic) ProtoMessage()

func (*Diagnostic) ProtoReflect

func (x *Diagnostic) ProtoReflect() protoreflect.Message

func (*Diagnostic) Reset

func (x *Diagnostic) Reset()

func (*Diagnostic) String

func (x *Diagnostic) String() string

type DiagnosticContext

type DiagnosticContext struct {

	// The category of the diagnostic.
	// This is used to group diagnostics into categories
	// to create more user-friendly action-oriented messages.
	Category string `protobuf:"bytes,1,opt,name=category" json:"category,omitempty"`
	// Reason code from the parent error for programmatic identification.
	ReasonCode string `protobuf:"bytes,2,opt,name=reason_code,json=reasonCode" json:"reason_code,omitempty"`
	// Suggested actions that the user can take.
	SuggestedActions []*DiagnosticSuggestedAction `protobuf:"bytes,3,rep,name=suggested_actions,json=suggestedActions" json:"suggested_actions,omitempty"`
	// Additional metadata for the diagnostic.
	Metadata *anypb.Any `protobuf:"bytes,4,opt,name=metadata" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

DiagnosticContext holds additional context for a diagnostic.

func (*DiagnosticContext) Descriptor deprecated

func (*DiagnosticContext) Descriptor() ([]byte, []int)

Deprecated: Use DiagnosticContext.ProtoReflect.Descriptor instead.

func (*DiagnosticContext) GetCategory

func (x *DiagnosticContext) GetCategory() string

func (*DiagnosticContext) GetMetadata

func (x *DiagnosticContext) GetMetadata() *anypb.Any

func (*DiagnosticContext) GetReasonCode

func (x *DiagnosticContext) GetReasonCode() string

func (*DiagnosticContext) GetSuggestedActions

func (x *DiagnosticContext) GetSuggestedActions() []*DiagnosticSuggestedAction

func (*DiagnosticContext) ProtoMessage

func (*DiagnosticContext) ProtoMessage()

func (*DiagnosticContext) ProtoReflect

func (x *DiagnosticContext) ProtoReflect() protoreflect.Message

func (*DiagnosticContext) Reset

func (x *DiagnosticContext) Reset()

func (*DiagnosticContext) String

func (x *DiagnosticContext) String() string

type DiagnosticLevel

type DiagnosticLevel int32

DiagnosticLevel is an enum for the level of a diagnostic.

const (
	// protobuf enums must have a zero value, so we need a NONE value
	// here.
	// DiagnosticLevel starts at 1 as per the Blueprint framework.
	DiagnosticLevel_DIAGNOSTIC_LEVEL_NONE DiagnosticLevel = 0
	// Indicates an error diagnostic.
	DiagnosticLevel_DIAGNOSTIC_LEVEL_ERROR DiagnosticLevel = 1
	// Indicates a warning diagnostic.
	DiagnosticLevel_DIAGNOSTIC_LEVEL_WARNING DiagnosticLevel = 2
	// Indicates an informational diagnostic.
	DiagnosticLevel_DIAGNOSTIC_LEVEL_INFO DiagnosticLevel = 3
)

func (DiagnosticLevel) Descriptor

func (DiagnosticLevel) Enum

func (x DiagnosticLevel) Enum() *DiagnosticLevel

func (DiagnosticLevel) EnumDescriptor deprecated

func (DiagnosticLevel) EnumDescriptor() ([]byte, []int)

Deprecated: Use DiagnosticLevel.Descriptor instead.

func (DiagnosticLevel) Number

func (DiagnosticLevel) String

func (x DiagnosticLevel) String() string

func (DiagnosticLevel) Type

type DiagnosticRange

type DiagnosticRange struct {
	Start          *SourceMeta    `protobuf:"bytes,1,opt,name=start" json:"start,omitempty"`
	End            *SourceMeta    `protobuf:"bytes,2,opt,name=end" json:"end,omitempty"`
	ColumnAccuracy ColumnAccuracy `` /* 131-byte string literal not displayed */
	// contains filtered or unexported fields
}

A range in the source blueprint that a diagnostic applies to. This will only be used for source formats that allow position tracking (i.e. YAML source documents).

func (*DiagnosticRange) Descriptor deprecated

func (*DiagnosticRange) Descriptor() ([]byte, []int)

Deprecated: Use DiagnosticRange.ProtoReflect.Descriptor instead.

func (*DiagnosticRange) GetColumnAccuracy

func (x *DiagnosticRange) GetColumnAccuracy() ColumnAccuracy

func (*DiagnosticRange) GetEnd

func (x *DiagnosticRange) GetEnd() *SourceMeta

func (*DiagnosticRange) GetStart

func (x *DiagnosticRange) GetStart() *SourceMeta

func (*DiagnosticRange) ProtoMessage

func (*DiagnosticRange) ProtoMessage()

func (*DiagnosticRange) ProtoReflect

func (x *DiagnosticRange) ProtoReflect() protoreflect.Message

func (*DiagnosticRange) Reset

func (x *DiagnosticRange) Reset()

func (*DiagnosticRange) String

func (x *DiagnosticRange) String() string

type DiagnosticSuggestedAction

type DiagnosticSuggestedAction struct {

	// The type of the suggested action.
	Type string `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
	// The title of the suggested action.
	Title string `protobuf:"bytes,2,opt,name=title" json:"title,omitempty"`
	// The description of the suggested action.
	Description string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	// The priority of the suggested action.
	Priority int32 `protobuf:"varint,4,opt,name=priority" json:"priority,omitempty"`
	// contains filtered or unexported fields
}

DiagnosticSuggestedAction holds a suggested action that the user can take in response to an error diagnostic.

func (*DiagnosticSuggestedAction) Descriptor deprecated

func (*DiagnosticSuggestedAction) Descriptor() ([]byte, []int)

Deprecated: Use DiagnosticSuggestedAction.ProtoReflect.Descriptor instead.

func (*DiagnosticSuggestedAction) GetDescription

func (x *DiagnosticSuggestedAction) GetDescription() string

func (*DiagnosticSuggestedAction) GetPriority

func (x *DiagnosticSuggestedAction) GetPriority() int32

func (*DiagnosticSuggestedAction) GetTitle

func (x *DiagnosticSuggestedAction) GetTitle() string

func (*DiagnosticSuggestedAction) GetType

func (x *DiagnosticSuggestedAction) GetType() string

func (*DiagnosticSuggestedAction) ProtoMessage

func (*DiagnosticSuggestedAction) ProtoMessage()

func (*DiagnosticSuggestedAction) ProtoReflect

func (*DiagnosticSuggestedAction) Reset

func (x *DiagnosticSuggestedAction) Reset()

func (*DiagnosticSuggestedAction) String

func (x *DiagnosticSuggestedAction) String() string

type ErrorCode

type ErrorCode int32

ErrorCode is an enum for a range of error codes for provider plugins.

const (
	// Indicates that the error is unexpected and the
	// action cannot be retried by the deploy engine
	// host.
	// This will not crash the deploy engine host but
	// will stop the current action (e.g. deploying a blueprint).
	ErrorCode_ERROR_CODE_UNEXPECTED ErrorCode = 0
	// Indicates that the failure is transient and the
	// action can be retried by the deploy engine
	// host based on the deploy engine host's retry policy.
	ErrorCode_ERROR_CODE_TRANSIENT ErrorCode = 1
	// Indicates that the input to the provider plugin
	// is invalid. Bad input errors should not be retried
	// but are distinguished from unexpected errors to allow
	// the deploy engine host to provide a more specific
	// error message to the user.
	ErrorCode_ERROR_CODE_BAD_INPUT ErrorCode = 2
)

func (ErrorCode) Descriptor

func (ErrorCode) Descriptor() protoreflect.EnumDescriptor

func (ErrorCode) Enum

func (x ErrorCode) Enum() *ErrorCode

func (ErrorCode) EnumDescriptor deprecated

func (ErrorCode) EnumDescriptor() ([]byte, []int)

Deprecated: Use ErrorCode.Descriptor instead.

func (ErrorCode) Number

func (x ErrorCode) Number() protoreflect.EnumNumber

func (ErrorCode) String

func (x ErrorCode) String() string

func (ErrorCode) Type

type ErrorResponse

type ErrorResponse struct {

	// An error code specific to the plugin system.
	// For example, an action that should be retried
	// would have a specific error code to let the deploy engine
	// host know that the action should be retried.
	Code ErrorCode `protobuf:"varint,1,opt,name=code,enum=sharedtypesv1.ErrorCode" json:"code,omitempty"`
	// A human-readable error message.
	Message string `protobuf:"bytes,2,opt,name=message" json:"message,omitempty"`
	// Extra details about the error.
	Details *anypb.Any `protobuf:"bytes,3,opt,name=details" json:"details,omitempty"`
	// contains filtered or unexported fields
}

Error response returned by the provider plugin when an error occurs during any of the supported provider plugin actions.

func NoResponsePBError

func NoResponsePBError() *ErrorResponse

NoResponsePBError returns an error response for when a plugin does not provide a valid response to a request.

func (*ErrorResponse) Descriptor deprecated

func (*ErrorResponse) Descriptor() ([]byte, []int)

Deprecated: Use ErrorResponse.ProtoReflect.Descriptor instead.

func (*ErrorResponse) GetCode

func (x *ErrorResponse) GetCode() ErrorCode

func (*ErrorResponse) GetDetails

func (x *ErrorResponse) GetDetails() *anypb.Any

func (*ErrorResponse) GetMessage

func (x *ErrorResponse) GetMessage() string

func (*ErrorResponse) ProtoMessage

func (*ErrorResponse) ProtoMessage()

func (*ErrorResponse) ProtoReflect

func (x *ErrorResponse) ProtoReflect() protoreflect.Message

func (*ErrorResponse) Reset

func (x *ErrorResponse) Reset()

func (*ErrorResponse) String

func (x *ErrorResponse) String() string

type Examples

type Examples struct {

	// A human-readable list of examples in plain text.
	Examples []string `protobuf:"bytes,1,rep,name=examples" json:"examples,omitempty"`
	// A human-readable list of examples in markdown format
	// that will usually be expected to contain code blocks.
	FormattedExamples []string `protobuf:"bytes,2,rep,name=formatted_examples,json=formattedExamples" json:"formatted_examples,omitempty"`
	// contains filtered or unexported fields
}

Examples for entities (e.g. resources) provided by a plugin.

func (*Examples) Descriptor deprecated

func (*Examples) Descriptor() ([]byte, []int)

Deprecated: Use Examples.ProtoReflect.Descriptor instead.

func (*Examples) GetExamples

func (x *Examples) GetExamples() []string

func (*Examples) GetFormattedExamples

func (x *Examples) GetFormattedExamples() []string

func (*Examples) ProtoMessage

func (*Examples) ProtoMessage()

func (*Examples) ProtoReflect

func (x *Examples) ProtoReflect() protoreflect.Message

func (*Examples) Reset

func (x *Examples) Reset()

func (*Examples) String

func (x *Examples) String() string

type ExamplesResponse

type ExamplesResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*ExamplesResponse_Examples
	//	*ExamplesResponse_ErrorResponse
	Response isExamplesResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

ExamplesResponse is the response containing examples for entities (e.g. resources) provided by a plugin.

func (*ExamplesResponse) Descriptor deprecated

func (*ExamplesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExamplesResponse.ProtoReflect.Descriptor instead.

func (*ExamplesResponse) GetErrorResponse

func (x *ExamplesResponse) GetErrorResponse() *ErrorResponse

func (*ExamplesResponse) GetExamples

func (x *ExamplesResponse) GetExamples() *Examples

func (*ExamplesResponse) GetResponse

func (x *ExamplesResponse) GetResponse() isExamplesResponse_Response

func (*ExamplesResponse) ProtoMessage

func (*ExamplesResponse) ProtoMessage()

func (*ExamplesResponse) ProtoReflect

func (x *ExamplesResponse) ProtoReflect() protoreflect.Message

func (*ExamplesResponse) Reset

func (x *ExamplesResponse) Reset()

func (*ExamplesResponse) String

func (x *ExamplesResponse) String() string

type ExamplesResponse_ErrorResponse

type ExamplesResponse_ErrorResponse struct {
	ErrorResponse *ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type ExamplesResponse_Examples

type ExamplesResponse_Examples struct {
	Examples *Examples `protobuf:"bytes,1,opt,name=examples,oneof"`
}

type FieldChange

type FieldChange struct {
	FieldPath string                `protobuf:"bytes,1,opt,name=field_path,json=fieldPath" json:"field_path,omitempty"`
	PrevValue *schemapb.MappingNode `protobuf:"bytes,2,opt,name=prev_value,json=prevValue" json:"prev_value,omitempty"`
	NewValue  *schemapb.MappingNode `protobuf:"bytes,3,opt,name=new_value,json=newValue" json:"new_value,omitempty"`
	// A flag that indicates whether the resource or link
	// containing the field must be recreated in order to apply the change.
	MustRecreate bool `protobuf:"varint,4,opt,name=must_recreate,json=mustRecreate" json:"must_recreate,omitempty"`
	// A flag that indicates whether the field is sensitive.
	// Sensitive fields are not included in logs or any other output.
	Sensitive bool `protobuf:"varint,5,opt,name=sensitive" json:"sensitive,omitempty"`
	// contains filtered or unexported fields
}

FieldChange represents a change in a field value of a resource or link that is used in change staging.

func (*FieldChange) Descriptor deprecated

func (*FieldChange) Descriptor() ([]byte, []int)

Deprecated: Use FieldChange.ProtoReflect.Descriptor instead.

func (*FieldChange) GetFieldPath

func (x *FieldChange) GetFieldPath() string

func (*FieldChange) GetMustRecreate

func (x *FieldChange) GetMustRecreate() bool

func (*FieldChange) GetNewValue

func (x *FieldChange) GetNewValue() *schemapb.MappingNode

func (*FieldChange) GetPrevValue

func (x *FieldChange) GetPrevValue() *schemapb.MappingNode

func (*FieldChange) GetSensitive

func (x *FieldChange) GetSensitive() bool

func (*FieldChange) ProtoMessage

func (*FieldChange) ProtoMessage()

func (*FieldChange) ProtoReflect

func (x *FieldChange) ProtoReflect() protoreflect.Message

func (*FieldChange) Reset

func (x *FieldChange) Reset()

func (*FieldChange) String

func (x *FieldChange) String() string

type FunctionAnyParameter

type FunctionAnyParameter struct {

	// The name of the parameter for functions that support named arguments.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The usage name for the parameter.
	// This will appear in logs and in tooling such as the
	// language server.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// A list of value type definitions that are allowed for the parameter.
	// When provided, an any parameter type is expected to be validated
	// as a union type where arguments must match of these types.
	UnionTypes []*FunctionValueTypeDefinition `protobuf:"bytes,3,rep,name=union_types,json=unionTypes" json:"union_types,omitempty"`
	// A human-readable description of the parameter.
	// This will appear in logs and tooling such as the
	// language server.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the parameter
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,5,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// Determines whether or not an argument passed in for
	// this parameter can be null.
	AllowNullValue bool `protobuf:"varint,6,opt,name=allow_null_value,json=allowNullValue" json:"allow_null_value,omitempty"`
	// Determines whether or not the value can be omitted.
	Optional bool `protobuf:"varint,7,opt,name=optional" json:"optional,omitempty"`
	// contains filtered or unexported fields
}

FunctionAnyParameter is a parameter type definition for any type. This can be used for union types as well as parameters that can accept any type.

func (*FunctionAnyParameter) Descriptor deprecated

func (*FunctionAnyParameter) Descriptor() ([]byte, []int)

Deprecated: Use FunctionAnyParameter.ProtoReflect.Descriptor instead.

func (*FunctionAnyParameter) GetAllowNullValue

func (x *FunctionAnyParameter) GetAllowNullValue() bool

func (*FunctionAnyParameter) GetDescription

func (x *FunctionAnyParameter) GetDescription() string

func (*FunctionAnyParameter) GetFormattedDescription

func (x *FunctionAnyParameter) GetFormattedDescription() string

func (*FunctionAnyParameter) GetLabel

func (x *FunctionAnyParameter) GetLabel() string

func (*FunctionAnyParameter) GetName

func (x *FunctionAnyParameter) GetName() string

func (*FunctionAnyParameter) GetOptional

func (x *FunctionAnyParameter) GetOptional() bool

func (*FunctionAnyParameter) GetUnionTypes

func (x *FunctionAnyParameter) GetUnionTypes() []*FunctionValueTypeDefinition

func (*FunctionAnyParameter) ProtoMessage

func (*FunctionAnyParameter) ProtoMessage()

func (*FunctionAnyParameter) ProtoReflect

func (x *FunctionAnyParameter) ProtoReflect() protoreflect.Message

func (*FunctionAnyParameter) Reset

func (x *FunctionAnyParameter) Reset()

func (*FunctionAnyParameter) String

func (x *FunctionAnyParameter) String() string

type FunctionAnyReturn

type FunctionAnyReturn struct {

	// This is the type definition for a return value that can be any type.
	Type FunctionValueType `protobuf:"varint,1,opt,name=type,enum=sharedtypesv1.FunctionValueType" json:"type,omitempty"`
	// UnionTypes is a list of value type definitions that are allowed for the return value.
	// When provided, an any return type is expected to be validated
	// as a union type where the return value must match one of these types.
	UnionTypes []*FunctionValueTypeDefinition `protobuf:"bytes,2,rep,name=union_types,json=unionTypes" json:"union_types,omitempty"`
	// A human-readable description of the return value.
	// This will appear in logs and in tooling such as the
	// language server.
	Description string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the return value
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,4,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// contains filtered or unexported fields
}

FunctionAnyReturn defines a return type for any type. This can be used for union types as well as return values that can be of any type.

func (*FunctionAnyReturn) Descriptor deprecated

func (*FunctionAnyReturn) Descriptor() ([]byte, []int)

Deprecated: Use FunctionAnyReturn.ProtoReflect.Descriptor instead.

func (*FunctionAnyReturn) GetDescription

func (x *FunctionAnyReturn) GetDescription() string

func (*FunctionAnyReturn) GetFormattedDescription

func (x *FunctionAnyReturn) GetFormattedDescription() string

func (*FunctionAnyReturn) GetType

func (x *FunctionAnyReturn) GetType() FunctionValueType

func (*FunctionAnyReturn) GetUnionTypes

func (x *FunctionAnyReturn) GetUnionTypes() []*FunctionValueTypeDefinition

func (*FunctionAnyReturn) ProtoMessage

func (*FunctionAnyReturn) ProtoMessage()

func (*FunctionAnyReturn) ProtoReflect

func (x *FunctionAnyReturn) ProtoReflect() protoreflect.Message

func (*FunctionAnyReturn) Reset

func (x *FunctionAnyReturn) Reset()

func (*FunctionAnyReturn) String

func (x *FunctionAnyReturn) String() string

type FunctionAnyValueTypeDefinition

type FunctionAnyValueTypeDefinition struct {

	// The value type name for an any type.
	Type FunctionValueType `protobuf:"varint,1,opt,name=type,enum=sharedtypesv1.FunctionValueType" json:"type,omitempty"`
	// A list of value type definitions that are allowed for the value.
	// When provided, an any value type is expected to be validated
	// as a union type where the value must match one of these types.
	UnionTypes []*FunctionValueTypeDefinition `protobuf:"bytes,2,rep,name=union_types,json=unionTypes" json:"union_types,omitempty"`
	// Usage name for the value type.
	Label string `protobuf:"bytes,3,opt,name=label" json:"label,omitempty"`
	// A human-readable description of the value type.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the value type
	// that is formatted with markdown.
	FormattedDescription string `protobuf:"bytes,5,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// contains filtered or unexported fields
}

FunctionAnyValueTypeDefinition is a value type definition for any type.

func (*FunctionAnyValueTypeDefinition) Descriptor deprecated

func (*FunctionAnyValueTypeDefinition) Descriptor() ([]byte, []int)

Deprecated: Use FunctionAnyValueTypeDefinition.ProtoReflect.Descriptor instead.

func (*FunctionAnyValueTypeDefinition) GetDescription

func (x *FunctionAnyValueTypeDefinition) GetDescription() string

func (*FunctionAnyValueTypeDefinition) GetFormattedDescription

func (x *FunctionAnyValueTypeDefinition) GetFormattedDescription() string

func (*FunctionAnyValueTypeDefinition) GetLabel

func (x *FunctionAnyValueTypeDefinition) GetLabel() string

func (*FunctionAnyValueTypeDefinition) GetType

func (*FunctionAnyValueTypeDefinition) GetUnionTypes

func (*FunctionAnyValueTypeDefinition) ProtoMessage

func (*FunctionAnyValueTypeDefinition) ProtoMessage()

func (*FunctionAnyValueTypeDefinition) ProtoReflect

func (*FunctionAnyValueTypeDefinition) Reset

func (x *FunctionAnyValueTypeDefinition) Reset()

func (*FunctionAnyValueTypeDefinition) String

type FunctionCall

type FunctionCall struct {

	// The file path of the source blueprint
	// where the function call is located.
	// This is especially useful for debugging projects with multiple
	// blueprints or in a multi-stage validation/deployment process
	// where the blueprint is one of many files that could have caused
	// an error.
	FilePath     string `protobuf:"bytes,1,opt,name=file_path,json=filePath" json:"file_path,omitempty"`
	FunctionName string `protobuf:"bytes,2,opt,name=function_name,json=functionName" json:"function_name,omitempty"`
	// The location of the function call in the source blueprint
	// that is captured in the schema and substitution parsing process.
	Location *SourceMeta `protobuf:"bytes,3,opt,name=location" json:"location,omitempty"`
	// contains filtered or unexported fields
}

FunctionCall holds information for a function call in a call stack.

func (*FunctionCall) Descriptor deprecated

func (*FunctionCall) Descriptor() ([]byte, []int)

Deprecated: Use FunctionCall.ProtoReflect.Descriptor instead.

func (*FunctionCall) GetFilePath

func (x *FunctionCall) GetFilePath() string

func (*FunctionCall) GetFunctionName

func (x *FunctionCall) GetFunctionName() string

func (*FunctionCall) GetLocation

func (x *FunctionCall) GetLocation() *SourceMeta

func (*FunctionCall) ProtoMessage

func (*FunctionCall) ProtoMessage()

func (*FunctionCall) ProtoReflect

func (x *FunctionCall) ProtoReflect() protoreflect.Message

func (*FunctionCall) Reset

func (x *FunctionCall) Reset()

func (*FunctionCall) String

func (x *FunctionCall) String() string

type FunctionCallArgs

type FunctionCallArgs struct {

	// Arguments are expected to be stored in a serialised JSON array
	// which allows the call args list to be deserialised once into a list instead
	// of having to deserialise each argument individually.
	// There is no concept of named args in the deploy engine host runtime,
	// it is down to function implementation to handle derive named args
	// from the list of arguments. (e.g. extract the first arg as a map)
	Args *anypb.Any `protobuf:"bytes,1,opt,name=args" json:"args,omitempty"`
	// contains filtered or unexported fields
}

FunctionCallArgs contains the arguments for calling a provider function.

func (*FunctionCallArgs) Descriptor deprecated

func (*FunctionCallArgs) Descriptor() ([]byte, []int)

Deprecated: Use FunctionCallArgs.ProtoReflect.Descriptor instead.

func (*FunctionCallArgs) GetArgs

func (x *FunctionCallArgs) GetArgs() *anypb.Any

func (*FunctionCallArgs) ProtoMessage

func (*FunctionCallArgs) ProtoMessage()

func (*FunctionCallArgs) ProtoReflect

func (x *FunctionCallArgs) ProtoReflect() protoreflect.Message

func (*FunctionCallArgs) Reset

func (x *FunctionCallArgs) Reset()

func (*FunctionCallArgs) String

func (x *FunctionCallArgs) String() string

type FunctionCallContext

type FunctionCallContext struct {
	Params          *BlueprintParams `protobuf:"bytes,1,opt,name=params" json:"params,omitempty"`
	CallStack       []*FunctionCall  `protobuf:"bytes,2,rep,name=call_stack,json=callStack" json:"call_stack,omitempty"`
	CurrentLocation *SourceMeta      `protobuf:"bytes,3,opt,name=current_location,json=currentLocation" json:"current_location,omitempty"`
	// contains filtered or unexported fields
}

FunctionCallContext contains the current environment context for calling a function.

func (*FunctionCallContext) Descriptor deprecated

func (*FunctionCallContext) Descriptor() ([]byte, []int)

Deprecated: Use FunctionCallContext.ProtoReflect.Descriptor instead.

func (*FunctionCallContext) GetCallStack

func (x *FunctionCallContext) GetCallStack() []*FunctionCall

func (*FunctionCallContext) GetCurrentLocation

func (x *FunctionCallContext) GetCurrentLocation() *SourceMeta

func (*FunctionCallContext) GetParams

func (x *FunctionCallContext) GetParams() *BlueprintParams

func (*FunctionCallContext) ProtoMessage

func (*FunctionCallContext) ProtoMessage()

func (*FunctionCallContext) ProtoReflect

func (x *FunctionCallContext) ProtoReflect() protoreflect.Message

func (*FunctionCallContext) Reset

func (x *FunctionCallContext) Reset()

func (*FunctionCallContext) String

func (x *FunctionCallContext) String() string

type FunctionCallRequest

type FunctionCallRequest struct {
	FunctionName string `protobuf:"bytes,1,opt,name=function_name,json=functionName" json:"function_name,omitempty"`
	// The ID of the host making the request
	// to the provider.
	HostId      string               `protobuf:"bytes,2,opt,name=host_id,json=hostId" json:"host_id,omitempty"`
	Args        *FunctionCallArgs    `protobuf:"bytes,3,opt,name=args" json:"args,omitempty"`
	CallContext *FunctionCallContext `protobuf:"bytes,4,opt,name=call_context,json=callContext" json:"call_context,omitempty"`
	// contains filtered or unexported fields
}

FunctionCallRequest is the request input for calling a function.

func (*FunctionCallRequest) Descriptor deprecated

func (*FunctionCallRequest) Descriptor() ([]byte, []int)

Deprecated: Use FunctionCallRequest.ProtoReflect.Descriptor instead.

func (*FunctionCallRequest) GetArgs

func (x *FunctionCallRequest) GetArgs() *FunctionCallArgs

func (*FunctionCallRequest) GetCallContext

func (x *FunctionCallRequest) GetCallContext() *FunctionCallContext

func (*FunctionCallRequest) GetFunctionName

func (x *FunctionCallRequest) GetFunctionName() string

func (*FunctionCallRequest) GetHostId

func (x *FunctionCallRequest) GetHostId() string

func (*FunctionCallRequest) ProtoMessage

func (*FunctionCallRequest) ProtoMessage()

func (*FunctionCallRequest) ProtoReflect

func (x *FunctionCallRequest) ProtoReflect() protoreflect.Message

func (*FunctionCallRequest) Reset

func (x *FunctionCallRequest) Reset()

func (*FunctionCallRequest) String

func (x *FunctionCallRequest) String() string

type FunctionCallResponse

type FunctionCallResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*FunctionCallResponse_FunctionResult
	//	*FunctionCallResponse_ErrorResponse
	Response isFunctionCallResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

FunctionCallResponse is the response containing the result of calling a function.

func (*FunctionCallResponse) Descriptor deprecated

func (*FunctionCallResponse) Descriptor() ([]byte, []int)

Deprecated: Use FunctionCallResponse.ProtoReflect.Descriptor instead.

func (*FunctionCallResponse) GetErrorResponse

func (x *FunctionCallResponse) GetErrorResponse() *ErrorResponse

func (*FunctionCallResponse) GetFunctionResult

func (x *FunctionCallResponse) GetFunctionResult() *FunctionCallResult

func (*FunctionCallResponse) GetResponse

func (x *FunctionCallResponse) GetResponse() isFunctionCallResponse_Response

func (*FunctionCallResponse) ProtoMessage

func (*FunctionCallResponse) ProtoMessage()

func (*FunctionCallResponse) ProtoReflect

func (x *FunctionCallResponse) ProtoReflect() protoreflect.Message

func (*FunctionCallResponse) Reset

func (x *FunctionCallResponse) Reset()

func (*FunctionCallResponse) String

func (x *FunctionCallResponse) String() string

type FunctionCallResponse_ErrorResponse

type FunctionCallResponse_ErrorResponse struct {
	ErrorResponse *ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type FunctionCallResponse_FunctionResult

type FunctionCallResponse_FunctionResult struct {
	FunctionResult *FunctionCallResult `protobuf:"bytes,1,opt,name=function_result,json=functionResult,oneof"`
}

type FunctionCallResult

type FunctionCallResult struct {
	ResponseData *anypb.Any           `protobuf:"bytes,1,opt,name=response_data,json=responseData" json:"response_data,omitempty"`
	FunctionInfo *FunctionRuntimeInfo `protobuf:"bytes,2,opt,name=function_info,json=functionInfo" json:"function_info,omitempty"`
	// contains filtered or unexported fields
}

FunctionCallResult contains the result of calling a function.

func (*FunctionCallResult) Descriptor deprecated

func (*FunctionCallResult) Descriptor() ([]byte, []int)

Deprecated: Use FunctionCallResult.ProtoReflect.Descriptor instead.

func (*FunctionCallResult) GetFunctionInfo

func (x *FunctionCallResult) GetFunctionInfo() *FunctionRuntimeInfo

func (*FunctionCallResult) GetResponseData

func (x *FunctionCallResult) GetResponseData() *anypb.Any

func (*FunctionCallResult) ProtoMessage

func (*FunctionCallResult) ProtoMessage()

func (*FunctionCallResult) ProtoReflect

func (x *FunctionCallResult) ProtoReflect() protoreflect.Message

func (*FunctionCallResult) Reset

func (x *FunctionCallResult) Reset()

func (*FunctionCallResult) String

func (x *FunctionCallResult) String() string

type FunctionDefinition

type FunctionDefinition struct {

	// The globally unique name of the function.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// A human-readable summary to be used in documentation and
	// tooling when listing functions.
	Summary string `protobuf:"bytes,2,opt,name=summary" json:"summary,omitempty"`
	// A human-readable summary of the function that is formatted with markdown.
	FormattedSummary string `protobuf:"bytes,3,opt,name=formatted_summary,json=formattedSummary" json:"formatted_summary,omitempty"`
	// A human-readable description of the function.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the function that is
	// formatted with markdown.
	FormattedDescription string `protobuf:"bytes,5,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// A definition of the parameters that are expected
	// to be passed into the function.
	// The order of the parameters is important as it will be used
	// to match arguments passed into the function.
	Parameters []*FunctionParameter `protobuf:"bytes,6,rep,name=parameters" json:"parameters,omitempty"`
	// A definition of the return type of the function.
	// Return types are always expected as provider functions are
	// expected to be pure functions that return an output based
	// on the input arguments without side effects.
	// Functions can also return other functions that can be shared,
	// this especially useful for function composition and partial application
	// of functions used in mapping over arrays or similar operations.
	Return *FunctionReturn `protobuf:"bytes,7,opt,name=return" json:"return,omitempty"`
	// Determines whether or not the function is an internal function
	// that should not be exposed to end-users.
	// Some internal functions are required to enable capabilities
	// such as function composition, piping and a small collection of other
	// higher-order functions.
	Internal bool `protobuf:"varint,8,opt,name=internal" json:"internal,omitempty"`
	// contains filtered or unexported fields
}

FunctionDefinition describes a function that can be used in a blueprint "${..}" substitution. This is used to define the parameters and return types of a function that is used to validate arguments passed into a function and the return value of a function.

func (*FunctionDefinition) Descriptor deprecated

func (*FunctionDefinition) Descriptor() ([]byte, []int)

Deprecated: Use FunctionDefinition.ProtoReflect.Descriptor instead.

func (*FunctionDefinition) GetDescription

func (x *FunctionDefinition) GetDescription() string

func (*FunctionDefinition) GetFormattedDescription

func (x *FunctionDefinition) GetFormattedDescription() string

func (*FunctionDefinition) GetFormattedSummary

func (x *FunctionDefinition) GetFormattedSummary() string

func (*FunctionDefinition) GetInternal

func (x *FunctionDefinition) GetInternal() bool

func (*FunctionDefinition) GetName

func (x *FunctionDefinition) GetName() string

func (*FunctionDefinition) GetParameters

func (x *FunctionDefinition) GetParameters() []*FunctionParameter

func (*FunctionDefinition) GetReturn

func (x *FunctionDefinition) GetReturn() *FunctionReturn

func (*FunctionDefinition) GetSummary

func (x *FunctionDefinition) GetSummary() string

func (*FunctionDefinition) ProtoMessage

func (*FunctionDefinition) ProtoMessage()

func (*FunctionDefinition) ProtoReflect

func (x *FunctionDefinition) ProtoReflect() protoreflect.Message

func (*FunctionDefinition) Reset

func (x *FunctionDefinition) Reset()

func (*FunctionDefinition) String

func (x *FunctionDefinition) String() string

type FunctionDefinitionRequest

type FunctionDefinitionRequest struct {
	FunctionName string `protobuf:"bytes,1,opt,name=function_name,json=functionName" json:"function_name,omitempty"`
	// The ID of the host making the request
	// to the provider.
	HostId string           `protobuf:"bytes,2,opt,name=host_id,json=hostId" json:"host_id,omitempty"`
	Params *BlueprintParams `protobuf:"bytes,3,opt,name=params" json:"params,omitempty"`
	// contains filtered or unexported fields
}

FunctionDefinitionRequest is the request input for fetching the definition of a function.

func (*FunctionDefinitionRequest) Descriptor deprecated

func (*FunctionDefinitionRequest) Descriptor() ([]byte, []int)

Deprecated: Use FunctionDefinitionRequest.ProtoReflect.Descriptor instead.

func (*FunctionDefinitionRequest) GetFunctionName

func (x *FunctionDefinitionRequest) GetFunctionName() string

func (*FunctionDefinitionRequest) GetHostId

func (x *FunctionDefinitionRequest) GetHostId() string

func (*FunctionDefinitionRequest) GetParams

func (*FunctionDefinitionRequest) ProtoMessage

func (*FunctionDefinitionRequest) ProtoMessage()

func (*FunctionDefinitionRequest) ProtoReflect

func (*FunctionDefinitionRequest) Reset

func (x *FunctionDefinitionRequest) Reset()

func (*FunctionDefinitionRequest) String

func (x *FunctionDefinitionRequest) String() string

type FunctionDefinitionResponse

type FunctionDefinitionResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*FunctionDefinitionResponse_FunctionDefinition
	//	*FunctionDefinitionResponse_ErrorResponse
	Response isFunctionDefinitionResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

FunctionDefinitionResponse is the response containing the definition of a function.

func (*FunctionDefinitionResponse) Descriptor deprecated

func (*FunctionDefinitionResponse) Descriptor() ([]byte, []int)

Deprecated: Use FunctionDefinitionResponse.ProtoReflect.Descriptor instead.

func (*FunctionDefinitionResponse) GetErrorResponse

func (x *FunctionDefinitionResponse) GetErrorResponse() *ErrorResponse

func (*FunctionDefinitionResponse) GetFunctionDefinition

func (x *FunctionDefinitionResponse) GetFunctionDefinition() *FunctionDefinition

func (*FunctionDefinitionResponse) GetResponse

func (x *FunctionDefinitionResponse) GetResponse() isFunctionDefinitionResponse_Response

func (*FunctionDefinitionResponse) ProtoMessage

func (*FunctionDefinitionResponse) ProtoMessage()

func (*FunctionDefinitionResponse) ProtoReflect

func (*FunctionDefinitionResponse) Reset

func (x *FunctionDefinitionResponse) Reset()

func (*FunctionDefinitionResponse) String

func (x *FunctionDefinitionResponse) String() string

type FunctionDefinitionResponse_ErrorResponse

type FunctionDefinitionResponse_ErrorResponse struct {
	ErrorResponse *ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type FunctionDefinitionResponse_FunctionDefinition

type FunctionDefinitionResponse_FunctionDefinition struct {
	FunctionDefinition *FunctionDefinition `protobuf:"bytes,1,opt,name=function_definition,json=functionDefinition,oneof"`
}

type FunctionListParameter

type FunctionListParameter struct {

	// The name of the parameter for functions that support named arguments.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The usage name for the parameter.
	// This will appear in logs and in tooling such as the
	// language server.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// Type of elements in the list, an argument will be validated
	// against this type.
	ElementType *FunctionValueTypeDefinition `protobuf:"bytes,3,opt,name=element_type,json=elementType" json:"element_type,omitempty"`
	// A human-readable description of the parameter.
	// This will appear in logs and tooling such as the
	// language server.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the parameter
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,5,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// Determines whether or not an argument passed in for
	// this parameter can be null.
	AllowNullValue bool `protobuf:"varint,6,opt,name=allow_null_value,json=allowNullValue" json:"allow_null_value,omitempty"`
	// Determines whether or not the value can be omitted.
	Optional bool `protobuf:"varint,7,opt,name=optional" json:"optional,omitempty"`
	// contains filtered or unexported fields
}

FunctionListParameter is a parameter type definition for lists.

func (*FunctionListParameter) Descriptor deprecated

func (*FunctionListParameter) Descriptor() ([]byte, []int)

Deprecated: Use FunctionListParameter.ProtoReflect.Descriptor instead.

func (*FunctionListParameter) GetAllowNullValue

func (x *FunctionListParameter) GetAllowNullValue() bool

func (*FunctionListParameter) GetDescription

func (x *FunctionListParameter) GetDescription() string

func (*FunctionListParameter) GetElementType

func (*FunctionListParameter) GetFormattedDescription

func (x *FunctionListParameter) GetFormattedDescription() string

func (*FunctionListParameter) GetLabel

func (x *FunctionListParameter) GetLabel() string

func (*FunctionListParameter) GetName

func (x *FunctionListParameter) GetName() string

func (*FunctionListParameter) GetOptional

func (x *FunctionListParameter) GetOptional() bool

func (*FunctionListParameter) ProtoMessage

func (*FunctionListParameter) ProtoMessage()

func (*FunctionListParameter) ProtoReflect

func (x *FunctionListParameter) ProtoReflect() protoreflect.Message

func (*FunctionListParameter) Reset

func (x *FunctionListParameter) Reset()

func (*FunctionListParameter) String

func (x *FunctionListParameter) String() string

type FunctionListReturn

type FunctionListReturn struct {

	// The type definition for the elements in the list.
	ElementType *FunctionValueTypeDefinition `protobuf:"bytes,1,opt,name=element_type,json=elementType" json:"element_type,omitempty"`
	// A human-readable description of the return value.
	// This will appear in logs and in tooling such as the
	// language server.
	Description string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the return value
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,3,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// contains filtered or unexported fields
}

FunctionListReturn defines a return type for a list of values with a single type.

func (*FunctionListReturn) Descriptor deprecated

func (*FunctionListReturn) Descriptor() ([]byte, []int)

Deprecated: Use FunctionListReturn.ProtoReflect.Descriptor instead.

func (*FunctionListReturn) GetDescription

func (x *FunctionListReturn) GetDescription() string

func (*FunctionListReturn) GetElementType

func (x *FunctionListReturn) GetElementType() *FunctionValueTypeDefinition

func (*FunctionListReturn) GetFormattedDescription

func (x *FunctionListReturn) GetFormattedDescription() string

func (*FunctionListReturn) ProtoMessage

func (*FunctionListReturn) ProtoMessage()

func (*FunctionListReturn) ProtoReflect

func (x *FunctionListReturn) ProtoReflect() protoreflect.Message

func (*FunctionListReturn) Reset

func (x *FunctionListReturn) Reset()

func (*FunctionListReturn) String

func (x *FunctionListReturn) String() string

type FunctionListValueTypeDefinition

type FunctionListValueTypeDefinition struct {

	// The type definition for the elements in the list.
	ElementType *FunctionValueTypeDefinition `protobuf:"bytes,1,opt,name=element_type,json=elementType" json:"element_type,omitempty"`
	// Usage name for the value type.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// A human-readable description of the value type.
	Description string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the value type
	// that is formatted with markdown.
	FormattedDescription string `protobuf:"bytes,4,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// contains filtered or unexported fields
}

FunctionListValueTypeDefinition is a value type definition for lists of values.

func (*FunctionListValueTypeDefinition) Descriptor deprecated

func (*FunctionListValueTypeDefinition) Descriptor() ([]byte, []int)

Deprecated: Use FunctionListValueTypeDefinition.ProtoReflect.Descriptor instead.

func (*FunctionListValueTypeDefinition) GetDescription

func (x *FunctionListValueTypeDefinition) GetDescription() string

func (*FunctionListValueTypeDefinition) GetElementType

func (*FunctionListValueTypeDefinition) GetFormattedDescription

func (x *FunctionListValueTypeDefinition) GetFormattedDescription() string

func (*FunctionListValueTypeDefinition) GetLabel

func (*FunctionListValueTypeDefinition) ProtoMessage

func (*FunctionListValueTypeDefinition) ProtoMessage()

func (*FunctionListValueTypeDefinition) ProtoReflect

func (*FunctionListValueTypeDefinition) Reset

func (*FunctionListValueTypeDefinition) String

type FunctionMapParameter

type FunctionMapParameter struct {

	// The name of the parameter for functions that support named arguments.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The usage name for the parameter.
	// This will appear in logs and in tooling such as the
	// language server.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// Type of values in the map, an argument will be validated
	// against this type.
	ElementType *FunctionValueTypeDefinition `protobuf:"bytes,3,opt,name=element_type,json=elementType" json:"element_type,omitempty"`
	// A human-readable description of the parameter.
	// This will appear in logs and tooling such as the
	// language server.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the parameter
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,5,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// Determines whether or not an argument passed in for
	// this parameter can be null.
	AllowNullValue bool `protobuf:"varint,6,opt,name=allow_null_value,json=allowNullValue" json:"allow_null_value,omitempty"`
	// Determines whether or not the value can be omitted.
	Optional bool `protobuf:"varint,7,opt,name=optional" json:"optional,omitempty"`
	// contains filtered or unexported fields
}

FunctionMapParameter is a parameter type definition for maps.

func (*FunctionMapParameter) Descriptor deprecated

func (*FunctionMapParameter) Descriptor() ([]byte, []int)

Deprecated: Use FunctionMapParameter.ProtoReflect.Descriptor instead.

func (*FunctionMapParameter) GetAllowNullValue

func (x *FunctionMapParameter) GetAllowNullValue() bool

func (*FunctionMapParameter) GetDescription

func (x *FunctionMapParameter) GetDescription() string

func (*FunctionMapParameter) GetElementType

func (*FunctionMapParameter) GetFormattedDescription

func (x *FunctionMapParameter) GetFormattedDescription() string

func (*FunctionMapParameter) GetLabel

func (x *FunctionMapParameter) GetLabel() string

func (*FunctionMapParameter) GetName

func (x *FunctionMapParameter) GetName() string

func (*FunctionMapParameter) GetOptional

func (x *FunctionMapParameter) GetOptional() bool

func (*FunctionMapParameter) ProtoMessage

func (*FunctionMapParameter) ProtoMessage()

func (*FunctionMapParameter) ProtoReflect

func (x *FunctionMapParameter) ProtoReflect() protoreflect.Message

func (*FunctionMapParameter) Reset

func (x *FunctionMapParameter) Reset()

func (*FunctionMapParameter) String

func (x *FunctionMapParameter) String() string

type FunctionMapReturn

type FunctionMapReturn struct {

	// The type definition for the values in the map.
	ElementType *FunctionValueTypeDefinition `protobuf:"bytes,1,opt,name=element_type,json=elementType" json:"element_type,omitempty"`
	// A human-readable description of the return value.
	// This will appear in logs and in tooling such as the
	// language server.
	Description string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the return value
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,3,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// contains filtered or unexported fields
}

FunctionMapReturn defines a return type for a map of strings to values with a single type.

func (*FunctionMapReturn) Descriptor deprecated

func (*FunctionMapReturn) Descriptor() ([]byte, []int)

Deprecated: Use FunctionMapReturn.ProtoReflect.Descriptor instead.

func (*FunctionMapReturn) GetDescription

func (x *FunctionMapReturn) GetDescription() string

func (*FunctionMapReturn) GetElementType

func (x *FunctionMapReturn) GetElementType() *FunctionValueTypeDefinition

func (*FunctionMapReturn) GetFormattedDescription

func (x *FunctionMapReturn) GetFormattedDescription() string

func (*FunctionMapReturn) ProtoMessage

func (*FunctionMapReturn) ProtoMessage()

func (*FunctionMapReturn) ProtoReflect

func (x *FunctionMapReturn) ProtoReflect() protoreflect.Message

func (*FunctionMapReturn) Reset

func (x *FunctionMapReturn) Reset()

func (*FunctionMapReturn) String

func (x *FunctionMapReturn) String() string

type FunctionMapValueTypeDefinition

type FunctionMapValueTypeDefinition struct {

	// The type definition for the values in the map.
	ElementType *FunctionValueTypeDefinition `protobuf:"bytes,1,opt,name=element_type,json=elementType" json:"element_type,omitempty"`
	// Usage name for the value type.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// A human-readable description of the value type.
	Description string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the value type
	// that is formatted with markdown.
	FormattedDescription string `protobuf:"bytes,4,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// contains filtered or unexported fields
}

FunctionMapValueTypeDefinition is a value type definition for a mapping of strings to values.

func (*FunctionMapValueTypeDefinition) Descriptor deprecated

func (*FunctionMapValueTypeDefinition) Descriptor() ([]byte, []int)

Deprecated: Use FunctionMapValueTypeDefinition.ProtoReflect.Descriptor instead.

func (*FunctionMapValueTypeDefinition) GetDescription

func (x *FunctionMapValueTypeDefinition) GetDescription() string

func (*FunctionMapValueTypeDefinition) GetElementType

func (*FunctionMapValueTypeDefinition) GetFormattedDescription

func (x *FunctionMapValueTypeDefinition) GetFormattedDescription() string

func (*FunctionMapValueTypeDefinition) GetLabel

func (x *FunctionMapValueTypeDefinition) GetLabel() string

func (*FunctionMapValueTypeDefinition) ProtoMessage

func (*FunctionMapValueTypeDefinition) ProtoMessage()

func (*FunctionMapValueTypeDefinition) ProtoReflect

func (*FunctionMapValueTypeDefinition) Reset

func (x *FunctionMapValueTypeDefinition) Reset()

func (*FunctionMapValueTypeDefinition) String

type FunctionObjectAttributeType

type FunctionObjectAttributeType struct {

	// The type definition for the attribute.
	Type *FunctionValueTypeDefinition `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
	// Determines whether or not the attribute can be null.
	AllowNullValue bool `protobuf:"varint,2,opt,name=allow_null_value,json=allowNullValue" json:"allow_null_value,omitempty"`
	// contains filtered or unexported fields
}

FunctionObjectAttributeType provides a wrapper around a value type definition that allows specific attributes of an object to be null.

func (*FunctionObjectAttributeType) Descriptor deprecated

func (*FunctionObjectAttributeType) Descriptor() ([]byte, []int)

Deprecated: Use FunctionObjectAttributeType.ProtoReflect.Descriptor instead.

func (*FunctionObjectAttributeType) GetAllowNullValue

func (x *FunctionObjectAttributeType) GetAllowNullValue() bool

func (*FunctionObjectAttributeType) GetType

func (*FunctionObjectAttributeType) ProtoMessage

func (*FunctionObjectAttributeType) ProtoMessage()

func (*FunctionObjectAttributeType) ProtoReflect

func (*FunctionObjectAttributeType) Reset

func (x *FunctionObjectAttributeType) Reset()

func (*FunctionObjectAttributeType) String

func (x *FunctionObjectAttributeType) String() string

type FunctionObjectParameter

type FunctionObjectParameter struct {

	// The name of the parameter for functions that support named arguments.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The usage name for the parameter.
	// This will appear in logs and in tooling such as the
	// language server.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// The type definition for an object including the type
	// of each named attribute.
	ObjectValueType *FunctionValueTypeDefinition `protobuf:"bytes,3,opt,name=object_value_type,json=objectValueType" json:"object_value_type,omitempty"`
	// A human-readable description of the parameter.
	// This will appear in logs and tooling such as the
	// language server.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the parameter
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,5,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// Determines whether or not an argument passed in for
	// this parameter can be null.
	AllowNullValue bool `protobuf:"varint,6,opt,name=allow_null_value,json=allowNullValue" json:"allow_null_value,omitempty"`
	// Determines whether or not the value can be omitted.
	Optional bool `protobuf:"varint,7,opt,name=optional" json:"optional,omitempty"`
	// contains filtered or unexported fields
}

FunctionObjectParameter is a parameter type definition for objects.

func (*FunctionObjectParameter) Descriptor deprecated

func (*FunctionObjectParameter) Descriptor() ([]byte, []int)

Deprecated: Use FunctionObjectParameter.ProtoReflect.Descriptor instead.

func (*FunctionObjectParameter) GetAllowNullValue

func (x *FunctionObjectParameter) GetAllowNullValue() bool

func (*FunctionObjectParameter) GetDescription

func (x *FunctionObjectParameter) GetDescription() string

func (*FunctionObjectParameter) GetFormattedDescription

func (x *FunctionObjectParameter) GetFormattedDescription() string

func (*FunctionObjectParameter) GetLabel

func (x *FunctionObjectParameter) GetLabel() string

func (*FunctionObjectParameter) GetName

func (x *FunctionObjectParameter) GetName() string

func (*FunctionObjectParameter) GetObjectValueType

func (x *FunctionObjectParameter) GetObjectValueType() *FunctionValueTypeDefinition

func (*FunctionObjectParameter) GetOptional

func (x *FunctionObjectParameter) GetOptional() bool

func (*FunctionObjectParameter) ProtoMessage

func (*FunctionObjectParameter) ProtoMessage()

func (*FunctionObjectParameter) ProtoReflect

func (x *FunctionObjectParameter) ProtoReflect() protoreflect.Message

func (*FunctionObjectParameter) Reset

func (x *FunctionObjectParameter) Reset()

func (*FunctionObjectParameter) String

func (x *FunctionObjectParameter) String() string

type FunctionObjectReturn

type FunctionObjectReturn struct {

	// The type definition for the object that is returned.
	ObjectValueType *FunctionValueTypeDefinition `protobuf:"bytes,1,opt,name=object_value_type,json=objectValueType" json:"object_value_type,omitempty"`
	// A human-readable description of the return value.
	// This will appear in logs and in tooling such as the
	// language server.
	Description string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the return value
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,3,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// contains filtered or unexported fields
}

FunctionObjectReturn defines a return type for an object with named attributes and their types.

func (*FunctionObjectReturn) Descriptor deprecated

func (*FunctionObjectReturn) Descriptor() ([]byte, []int)

Deprecated: Use FunctionObjectReturn.ProtoReflect.Descriptor instead.

func (*FunctionObjectReturn) GetDescription

func (x *FunctionObjectReturn) GetDescription() string

func (*FunctionObjectReturn) GetFormattedDescription

func (x *FunctionObjectReturn) GetFormattedDescription() string

func (*FunctionObjectReturn) GetObjectValueType

func (x *FunctionObjectReturn) GetObjectValueType() *FunctionValueTypeDefinition

func (*FunctionObjectReturn) ProtoMessage

func (*FunctionObjectReturn) ProtoMessage()

func (*FunctionObjectReturn) ProtoReflect

func (x *FunctionObjectReturn) ProtoReflect() protoreflect.Message

func (*FunctionObjectReturn) Reset

func (x *FunctionObjectReturn) Reset()

func (*FunctionObjectReturn) String

func (x *FunctionObjectReturn) String() string

type FunctionObjectValueTypeDefinition

type FunctionObjectValueTypeDefinition struct {

	// The type definition for each named attribute in the object.
	AttributeTypes map[string]*FunctionObjectAttributeType `` /* 170-byte string literal not displayed */
	// Usage name for the value type.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// A human-readable description of the value type.
	Description string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the value type
	// that is formatted with markdown.
	FormattedDescription string `protobuf:"bytes,4,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// contains filtered or unexported fields
}

FunctionObjectValueTypeDefinition is a value type definition for objects with named attributes.

func (*FunctionObjectValueTypeDefinition) Descriptor deprecated

func (*FunctionObjectValueTypeDefinition) Descriptor() ([]byte, []int)

Deprecated: Use FunctionObjectValueTypeDefinition.ProtoReflect.Descriptor instead.

func (*FunctionObjectValueTypeDefinition) GetAttributeTypes

func (*FunctionObjectValueTypeDefinition) GetDescription

func (x *FunctionObjectValueTypeDefinition) GetDescription() string

func (*FunctionObjectValueTypeDefinition) GetFormattedDescription

func (x *FunctionObjectValueTypeDefinition) GetFormattedDescription() string

func (*FunctionObjectValueTypeDefinition) GetLabel

func (*FunctionObjectValueTypeDefinition) ProtoMessage

func (*FunctionObjectValueTypeDefinition) ProtoMessage()

func (*FunctionObjectValueTypeDefinition) ProtoReflect

func (*FunctionObjectValueTypeDefinition) Reset

func (*FunctionObjectValueTypeDefinition) String

type FunctionParameter

type FunctionParameter struct {

	// Types that are valid to be assigned to Parameter:
	//
	//	*FunctionParameter_ScalarParameter
	//	*FunctionParameter_ListParameter
	//	*FunctionParameter_MapParameter
	//	*FunctionParameter_ObjectParameter
	//	*FunctionParameter_FunctionTypeParameter
	//	*FunctionParameter_VariadicParameter
	//	*FunctionParameter_AnyParameter
	Parameter isFunctionParameter_Parameter `protobuf_oneof:"parameter"`
	// contains filtered or unexported fields
}

FunctionParameter is a parameter type definition for arguments passed into a function.

func (*FunctionParameter) Descriptor deprecated

func (*FunctionParameter) Descriptor() ([]byte, []int)

Deprecated: Use FunctionParameter.ProtoReflect.Descriptor instead.

func (*FunctionParameter) GetAnyParameter

func (x *FunctionParameter) GetAnyParameter() *FunctionAnyParameter

func (*FunctionParameter) GetFunctionTypeParameter

func (x *FunctionParameter) GetFunctionTypeParameter() *FunctionTypeParameter

func (*FunctionParameter) GetListParameter

func (x *FunctionParameter) GetListParameter() *FunctionListParameter

func (*FunctionParameter) GetMapParameter

func (x *FunctionParameter) GetMapParameter() *FunctionMapParameter

func (*FunctionParameter) GetObjectParameter

func (x *FunctionParameter) GetObjectParameter() *FunctionObjectParameter

func (*FunctionParameter) GetParameter

func (x *FunctionParameter) GetParameter() isFunctionParameter_Parameter

func (*FunctionParameter) GetScalarParameter

func (x *FunctionParameter) GetScalarParameter() *FunctionScalarParameter

func (*FunctionParameter) GetVariadicParameter

func (x *FunctionParameter) GetVariadicParameter() *FunctionVariadicParameter

func (*FunctionParameter) ProtoMessage

func (*FunctionParameter) ProtoMessage()

func (*FunctionParameter) ProtoReflect

func (x *FunctionParameter) ProtoReflect() protoreflect.Message

func (*FunctionParameter) Reset

func (x *FunctionParameter) Reset()

func (*FunctionParameter) String

func (x *FunctionParameter) String() string

type FunctionParameter_AnyParameter

type FunctionParameter_AnyParameter struct {
	AnyParameter *FunctionAnyParameter `protobuf:"bytes,7,opt,name=any_parameter,json=anyParameter,oneof"`
}

type FunctionParameter_FunctionTypeParameter

type FunctionParameter_FunctionTypeParameter struct {
	FunctionTypeParameter *FunctionTypeParameter `protobuf:"bytes,5,opt,name=function_type_parameter,json=functionTypeParameter,oneof"`
}

type FunctionParameter_ListParameter

type FunctionParameter_ListParameter struct {
	ListParameter *FunctionListParameter `protobuf:"bytes,2,opt,name=list_parameter,json=listParameter,oneof"`
}

type FunctionParameter_MapParameter

type FunctionParameter_MapParameter struct {
	MapParameter *FunctionMapParameter `protobuf:"bytes,3,opt,name=map_parameter,json=mapParameter,oneof"`
}

type FunctionParameter_ObjectParameter

type FunctionParameter_ObjectParameter struct {
	ObjectParameter *FunctionObjectParameter `protobuf:"bytes,4,opt,name=object_parameter,json=objectParameter,oneof"`
}

type FunctionParameter_ScalarParameter

type FunctionParameter_ScalarParameter struct {
	ScalarParameter *FunctionScalarParameter `protobuf:"bytes,1,opt,name=scalar_parameter,json=scalarParameter,oneof"`
}

type FunctionParameter_VariadicParameter

type FunctionParameter_VariadicParameter struct {
	VariadicParameter *FunctionVariadicParameter `protobuf:"bytes,6,opt,name=variadic_parameter,json=variadicParameter,oneof"`
}

type FunctionReturn

type FunctionReturn struct {

	// Types that are valid to be assigned to Return:
	//
	//	*FunctionReturn_ScalarReturn
	//	*FunctionReturn_ListReturn
	//	*FunctionReturn_MapReturn
	//	*FunctionReturn_ObjectReturn
	//	*FunctionReturn_FunctionTypeReturn
	//	*FunctionReturn_AnyReturn
	Return isFunctionReturn_Return `protobuf_oneof:"return"`
	// contains filtered or unexported fields
}

FunctionReturn is a return type definition for the return value of a function.

func (*FunctionReturn) Descriptor deprecated

func (*FunctionReturn) Descriptor() ([]byte, []int)

Deprecated: Use FunctionReturn.ProtoReflect.Descriptor instead.

func (*FunctionReturn) GetAnyReturn

func (x *FunctionReturn) GetAnyReturn() *FunctionAnyReturn

func (*FunctionReturn) GetFunctionTypeReturn

func (x *FunctionReturn) GetFunctionTypeReturn() *FunctionTypeReturn

func (*FunctionReturn) GetListReturn

func (x *FunctionReturn) GetListReturn() *FunctionListReturn

func (*FunctionReturn) GetMapReturn

func (x *FunctionReturn) GetMapReturn() *FunctionMapReturn

func (*FunctionReturn) GetObjectReturn

func (x *FunctionReturn) GetObjectReturn() *FunctionObjectReturn

func (*FunctionReturn) GetReturn

func (x *FunctionReturn) GetReturn() isFunctionReturn_Return

func (*FunctionReturn) GetScalarReturn

func (x *FunctionReturn) GetScalarReturn() *FunctionScalarReturn

func (*FunctionReturn) ProtoMessage

func (*FunctionReturn) ProtoMessage()

func (*FunctionReturn) ProtoReflect

func (x *FunctionReturn) ProtoReflect() protoreflect.Message

func (*FunctionReturn) Reset

func (x *FunctionReturn) Reset()

func (*FunctionReturn) String

func (x *FunctionReturn) String() string

type FunctionReturn_AnyReturn

type FunctionReturn_AnyReturn struct {
	AnyReturn *FunctionAnyReturn `protobuf:"bytes,6,opt,name=any_return,json=anyReturn,oneof"`
}

type FunctionReturn_FunctionTypeReturn

type FunctionReturn_FunctionTypeReturn struct {
	FunctionTypeReturn *FunctionTypeReturn `protobuf:"bytes,5,opt,name=function_type_return,json=functionTypeReturn,oneof"`
}

type FunctionReturn_ListReturn

type FunctionReturn_ListReturn struct {
	ListReturn *FunctionListReturn `protobuf:"bytes,2,opt,name=list_return,json=listReturn,oneof"`
}

type FunctionReturn_MapReturn

type FunctionReturn_MapReturn struct {
	MapReturn *FunctionMapReturn `protobuf:"bytes,3,opt,name=map_return,json=mapReturn,oneof"`
}

type FunctionReturn_ObjectReturn

type FunctionReturn_ObjectReturn struct {
	ObjectReturn *FunctionObjectReturn `protobuf:"bytes,4,opt,name=object_return,json=objectReturn,oneof"`
}

type FunctionReturn_ScalarReturn

type FunctionReturn_ScalarReturn struct {
	ScalarReturn *FunctionScalarReturn `protobuf:"bytes,1,opt,name=scalar_return,json=scalarReturn,oneof"`
}

type FunctionRuntimeInfo

type FunctionRuntimeInfo struct {
	FunctionName string `protobuf:"bytes,1,opt,name=function_name,json=functionName" json:"function_name,omitempty"`
	// Partial args should be a serialised JSON array,
	// this means partial args only need to be deserialised once.
	PartialArgs *anypb.Any `protobuf:"bytes,2,opt,name=partial_args,json=partialArgs" json:"partial_args,omitempty"`
	// The offset of the arguments in the partial arguments.
	// This should be rarely be used, but in the case where the captured
	// arguments to be "partially applied" are not the first arguments
	// in the function signature, this can be used to specify the offset
	// of the arguments in the partial arguments list.
	ArgsOffset int32 `protobuf:"varint,3,opt,name=args_offset,json=argsOffset" json:"args_offset,omitempty"`
	// contains filtered or unexported fields
}

FunctionRuntimeInfo provides information about a function to be passed between functions. The blueprint function framework is designed to work across process boundaries so an actual function in memory can not be passed around, Instead, a function runtime info is used, this contains the function name to be called and pre-configured arguments that can be used when the function is eventually called.

Higher-order functions can only use named functions for the return value as the function name is used to look up the function definition and combine the pre-configured arguments with the arguments passed to the function.

func (*FunctionRuntimeInfo) Descriptor deprecated

func (*FunctionRuntimeInfo) Descriptor() ([]byte, []int)

Deprecated: Use FunctionRuntimeInfo.ProtoReflect.Descriptor instead.

func (*FunctionRuntimeInfo) GetArgsOffset

func (x *FunctionRuntimeInfo) GetArgsOffset() int32

func (*FunctionRuntimeInfo) GetFunctionName

func (x *FunctionRuntimeInfo) GetFunctionName() string

func (*FunctionRuntimeInfo) GetPartialArgs

func (x *FunctionRuntimeInfo) GetPartialArgs() *anypb.Any

func (*FunctionRuntimeInfo) ProtoMessage

func (*FunctionRuntimeInfo) ProtoMessage()

func (*FunctionRuntimeInfo) ProtoReflect

func (x *FunctionRuntimeInfo) ProtoReflect() protoreflect.Message

func (*FunctionRuntimeInfo) Reset

func (x *FunctionRuntimeInfo) Reset()

func (*FunctionRuntimeInfo) String

func (x *FunctionRuntimeInfo) String() string

type FunctionScalarParameter

type FunctionScalarParameter struct {

	// The name of the parameter for functions that support named arguments.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The usage name for the parameter.
	// This will appear in logs and in tooling such as the
	// language server.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// Type of the parameter, an argument will be validated
	// against this type.
	Type *FunctionValueTypeDefinition `protobuf:"bytes,3,opt,name=type" json:"type,omitempty"`
	// A human-readable description of the parameter.
	// This will appear in logs and tooling such as the
	// language server.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the parameter
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,5,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// Determines whether or not an argument passed in for
	// this parameter can be null.
	AllowNullValue bool `protobuf:"varint,6,opt,name=allow_null_value,json=allowNullValue" json:"allow_null_value,omitempty"`
	// Determines whether or not the value can be omitted.
	Optional bool `protobuf:"varint,7,opt,name=optional" json:"optional,omitempty"`
	// contains filtered or unexported fields
}

ScalarParameter is a parameter type definition for primitive types.

func (*FunctionScalarParameter) Descriptor deprecated

func (*FunctionScalarParameter) Descriptor() ([]byte, []int)

Deprecated: Use FunctionScalarParameter.ProtoReflect.Descriptor instead.

func (*FunctionScalarParameter) GetAllowNullValue

func (x *FunctionScalarParameter) GetAllowNullValue() bool

func (*FunctionScalarParameter) GetDescription

func (x *FunctionScalarParameter) GetDescription() string

func (*FunctionScalarParameter) GetFormattedDescription

func (x *FunctionScalarParameter) GetFormattedDescription() string

func (*FunctionScalarParameter) GetLabel

func (x *FunctionScalarParameter) GetLabel() string

func (*FunctionScalarParameter) GetName

func (x *FunctionScalarParameter) GetName() string

func (*FunctionScalarParameter) GetOptional

func (x *FunctionScalarParameter) GetOptional() bool

func (*FunctionScalarParameter) GetType

func (*FunctionScalarParameter) ProtoMessage

func (*FunctionScalarParameter) ProtoMessage()

func (*FunctionScalarParameter) ProtoReflect

func (x *FunctionScalarParameter) ProtoReflect() protoreflect.Message

func (*FunctionScalarParameter) Reset

func (x *FunctionScalarParameter) Reset()

func (*FunctionScalarParameter) String

func (x *FunctionScalarParameter) String() string

type FunctionScalarReturn

type FunctionScalarReturn struct {

	// This is the type definition for the scalar return value,
	// this should be a type definition that uses one of the scalar
	// value types such as ValueTypeString, ValueTypeInt32, etc.
	Type *FunctionValueTypeDefinition `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
	// A human-readable description of the return value.
	// This will appear in logs and in tooling such as the
	// language server.
	Description string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the return value
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,3,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// contains filtered or unexported fields
}

FunctionScalarReturn defines a return type for primitive types.

func (*FunctionScalarReturn) Descriptor deprecated

func (*FunctionScalarReturn) Descriptor() ([]byte, []int)

Deprecated: Use FunctionScalarReturn.ProtoReflect.Descriptor instead.

func (*FunctionScalarReturn) GetDescription

func (x *FunctionScalarReturn) GetDescription() string

func (*FunctionScalarReturn) GetFormattedDescription

func (x *FunctionScalarReturn) GetFormattedDescription() string

func (*FunctionScalarReturn) GetType

func (*FunctionScalarReturn) ProtoMessage

func (*FunctionScalarReturn) ProtoMessage()

func (*FunctionScalarReturn) ProtoReflect

func (x *FunctionScalarReturn) ProtoReflect() protoreflect.Message

func (*FunctionScalarReturn) Reset

func (x *FunctionScalarReturn) Reset()

func (*FunctionScalarReturn) String

func (x *FunctionScalarReturn) String() string

type FunctionScalarValueTypeDefinition

type FunctionScalarValueTypeDefinition struct {

	// The value type name for the scalar type.
	Type FunctionValueType `protobuf:"varint,1,opt,name=type,enum=sharedtypesv1.FunctionValueType" json:"type,omitempty"`
	// Usage name for the value type.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// A human-readable description of the value type.
	Description string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the value type
	// that is formatted with markdown.
	FormattedDescription string `protobuf:"bytes,4,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// A list of string values that are allowed
	// for values with this type.
	// This is only taken into account when the type is a string.
	StringChoices []string `protobuf:"bytes,5,rep,name=string_choices,json=stringChoices" json:"string_choices,omitempty"`
	// contains filtered or unexported fields
}

FunctionScalarValueTypeDefinition is a value type definition for scalar (primitive) types.

func (*FunctionScalarValueTypeDefinition) Descriptor deprecated

func (*FunctionScalarValueTypeDefinition) Descriptor() ([]byte, []int)

Deprecated: Use FunctionScalarValueTypeDefinition.ProtoReflect.Descriptor instead.

func (*FunctionScalarValueTypeDefinition) GetDescription

func (x *FunctionScalarValueTypeDefinition) GetDescription() string

func (*FunctionScalarValueTypeDefinition) GetFormattedDescription

func (x *FunctionScalarValueTypeDefinition) GetFormattedDescription() string

func (*FunctionScalarValueTypeDefinition) GetLabel

func (*FunctionScalarValueTypeDefinition) GetStringChoices

func (x *FunctionScalarValueTypeDefinition) GetStringChoices() []string

func (*FunctionScalarValueTypeDefinition) GetType

func (*FunctionScalarValueTypeDefinition) ProtoMessage

func (*FunctionScalarValueTypeDefinition) ProtoMessage()

func (*FunctionScalarValueTypeDefinition) ProtoReflect

func (*FunctionScalarValueTypeDefinition) Reset

func (*FunctionScalarValueTypeDefinition) String

type FunctionTypeParameter

type FunctionTypeParameter struct {

	// The name of the parameter for functions that support named arguments.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The usage name for the parameter.
	// This will appear in logs and in tooling such as the
	// language server.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// Type of function that represents the type signature
	// that defines the parameters and return type of the function.
	FunctionType *FunctionValueTypeDefinition `protobuf:"bytes,3,opt,name=function_type,json=functionType" json:"function_type,omitempty"`
	// A human-readable description of the parameter.
	// This will appear in logs and tooling such as the
	// language server.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the parameter
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,5,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// Determines whether or not an argument passed in for
	// this parameter can be null.
	AllowNullValue bool `protobuf:"varint,6,opt,name=allow_null_value,json=allowNullValue" json:"allow_null_value,omitempty"`
	// Determines whether or not the value can be omitted.
	Optional bool `protobuf:"varint,7,opt,name=optional" json:"optional,omitempty"`
	// contains filtered or unexported fields
}

FunctionTypeParameter is a parameter type definition for functions that can be passed as arguments to other functions.

func (*FunctionTypeParameter) Descriptor deprecated

func (*FunctionTypeParameter) Descriptor() ([]byte, []int)

Deprecated: Use FunctionTypeParameter.ProtoReflect.Descriptor instead.

func (*FunctionTypeParameter) GetAllowNullValue

func (x *FunctionTypeParameter) GetAllowNullValue() bool

func (*FunctionTypeParameter) GetDescription

func (x *FunctionTypeParameter) GetDescription() string

func (*FunctionTypeParameter) GetFormattedDescription

func (x *FunctionTypeParameter) GetFormattedDescription() string

func (*FunctionTypeParameter) GetFunctionType

func (x *FunctionTypeParameter) GetFunctionType() *FunctionValueTypeDefinition

func (*FunctionTypeParameter) GetLabel

func (x *FunctionTypeParameter) GetLabel() string

func (*FunctionTypeParameter) GetName

func (x *FunctionTypeParameter) GetName() string

func (*FunctionTypeParameter) GetOptional

func (x *FunctionTypeParameter) GetOptional() bool

func (*FunctionTypeParameter) ProtoMessage

func (*FunctionTypeParameter) ProtoMessage()

func (*FunctionTypeParameter) ProtoReflect

func (x *FunctionTypeParameter) ProtoReflect() protoreflect.Message

func (*FunctionTypeParameter) Reset

func (x *FunctionTypeParameter) Reset()

func (*FunctionTypeParameter) String

func (x *FunctionTypeParameter) String() string

type FunctionTypeReturn

type FunctionTypeReturn struct {

	// The type definition for the function that is returned.
	// This should be a type definition of the function signature
	// that defines the parameters and return type of the function.
	FunctionType *FunctionValueTypeDefinition `protobuf:"bytes,1,opt,name=function_type,json=functionType" json:"function_type,omitempty"`
	// A human-readable description of the return value.
	// This will appear in logs and in tooling such as the
	// language server.
	Description string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the return value
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,3,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// contains filtered or unexported fields
}

FunctionTypeReturn defines a return type for a function that can be returned from another function.

func (*FunctionTypeReturn) Descriptor deprecated

func (*FunctionTypeReturn) Descriptor() ([]byte, []int)

Deprecated: Use FunctionTypeReturn.ProtoReflect.Descriptor instead.

func (*FunctionTypeReturn) GetDescription

func (x *FunctionTypeReturn) GetDescription() string

func (*FunctionTypeReturn) GetFormattedDescription

func (x *FunctionTypeReturn) GetFormattedDescription() string

func (*FunctionTypeReturn) GetFunctionType

func (x *FunctionTypeReturn) GetFunctionType() *FunctionValueTypeDefinition

func (*FunctionTypeReturn) ProtoMessage

func (*FunctionTypeReturn) ProtoMessage()

func (*FunctionTypeReturn) ProtoReflect

func (x *FunctionTypeReturn) ProtoReflect() protoreflect.Message

func (*FunctionTypeReturn) Reset

func (x *FunctionTypeReturn) Reset()

func (*FunctionTypeReturn) String

func (x *FunctionTypeReturn) String() string

type FunctionTypeValueTypeDefinition

type FunctionTypeValueTypeDefinition struct {

	// The type definition for the function.
	FunctionType *FunctionDefinition `protobuf:"bytes,1,opt,name=function_type,json=functionType" json:"function_type,omitempty"`
	// Usage name for the value type.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// A human-readable description of the value type.
	Description string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the value type
	// that is formatted with markdown.
	FormattedDescription string `protobuf:"bytes,4,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// contains filtered or unexported fields
}

FunctionTypeValueTypeDefinition is a value type definition for functions that can be passed into and returned from other functions.

func (*FunctionTypeValueTypeDefinition) Descriptor deprecated

func (*FunctionTypeValueTypeDefinition) Descriptor() ([]byte, []int)

Deprecated: Use FunctionTypeValueTypeDefinition.ProtoReflect.Descriptor instead.

func (*FunctionTypeValueTypeDefinition) GetDescription

func (x *FunctionTypeValueTypeDefinition) GetDescription() string

func (*FunctionTypeValueTypeDefinition) GetFormattedDescription

func (x *FunctionTypeValueTypeDefinition) GetFormattedDescription() string

func (*FunctionTypeValueTypeDefinition) GetFunctionType

func (*FunctionTypeValueTypeDefinition) GetLabel

func (*FunctionTypeValueTypeDefinition) ProtoMessage

func (*FunctionTypeValueTypeDefinition) ProtoMessage()

func (*FunctionTypeValueTypeDefinition) ProtoReflect

func (*FunctionTypeValueTypeDefinition) Reset

func (*FunctionTypeValueTypeDefinition) String

type FunctionValueType

type FunctionValueType int32

FunctionValueType is an enum for the value types that are supported for function parameters and return types. This is translated to a string enum representation in the deploy engine.

const (
	FunctionValueType_FUNCTION_VALUE_TYPE_STRING   FunctionValueType = 0
	FunctionValueType_FUNCTION_VALUE_TYPE_INT32    FunctionValueType = 1
	FunctionValueType_FUNCTION_VALUE_TYPE_INT64    FunctionValueType = 2
	FunctionValueType_FUNCTION_VALUE_TYPE_UINT32   FunctionValueType = 3
	FunctionValueType_FUNCTION_VALUE_TYPE_UINT64   FunctionValueType = 4
	FunctionValueType_FUNCTION_VALUE_TYPE_FLOAT32  FunctionValueType = 5
	FunctionValueType_FUNCTION_VALUE_TYPE_FLOAT64  FunctionValueType = 6
	FunctionValueType_FUNCTION_VALUE_TYPE_BOOL     FunctionValueType = 7
	FunctionValueType_FUNCTION_VALUE_TYPE_LIST     FunctionValueType = 8
	FunctionValueType_FUNCTION_VALUE_TYPE_MAP      FunctionValueType = 9
	FunctionValueType_FUNCTION_VALUE_TYPE_OBJECT   FunctionValueType = 10
	FunctionValueType_FUNCTION_VALUE_TYPE_FUNCTION FunctionValueType = 11
	FunctionValueType_FUNCTION_VALUE_TYPE_ANY      FunctionValueType = 12
)

func (FunctionValueType) Descriptor

func (FunctionValueType) Enum

func (FunctionValueType) EnumDescriptor deprecated

func (FunctionValueType) EnumDescriptor() ([]byte, []int)

Deprecated: Use FunctionValueType.Descriptor instead.

func (FunctionValueType) Number

func (FunctionValueType) String

func (x FunctionValueType) String() string

func (FunctionValueType) Type

type FunctionValueTypeDefinition

type FunctionValueTypeDefinition struct {

	// Types that are valid to be assigned to ValueTypeDefinition:
	//
	//	*FunctionValueTypeDefinition_ScalarValueType
	//	*FunctionValueTypeDefinition_ListValueType
	//	*FunctionValueTypeDefinition_MapValueType
	//	*FunctionValueTypeDefinition_ObjectValueType
	//	*FunctionValueTypeDefinition_FunctionValueType
	//	*FunctionValueTypeDefinition_AnyValueType
	ValueTypeDefinition isFunctionValueTypeDefinition_ValueTypeDefinition `protobuf_oneof:"value_type_definition"`
	// contains filtered or unexported fields
}

FunctionValueTypeDefinition provides a definition for a value type that can be used for function parameters and return types.

func (*FunctionValueTypeDefinition) Descriptor deprecated

func (*FunctionValueTypeDefinition) Descriptor() ([]byte, []int)

Deprecated: Use FunctionValueTypeDefinition.ProtoReflect.Descriptor instead.

func (*FunctionValueTypeDefinition) GetAnyValueType

func (*FunctionValueTypeDefinition) GetFunctionValueType

func (*FunctionValueTypeDefinition) GetListValueType

func (*FunctionValueTypeDefinition) GetMapValueType

func (*FunctionValueTypeDefinition) GetObjectValueType

func (*FunctionValueTypeDefinition) GetScalarValueType

func (*FunctionValueTypeDefinition) GetValueTypeDefinition

func (x *FunctionValueTypeDefinition) GetValueTypeDefinition() isFunctionValueTypeDefinition_ValueTypeDefinition

func (*FunctionValueTypeDefinition) ProtoMessage

func (*FunctionValueTypeDefinition) ProtoMessage()

func (*FunctionValueTypeDefinition) ProtoReflect

func (*FunctionValueTypeDefinition) Reset

func (x *FunctionValueTypeDefinition) Reset()

func (*FunctionValueTypeDefinition) String

func (x *FunctionValueTypeDefinition) String() string

type FunctionValueTypeDefinition_AnyValueType

type FunctionValueTypeDefinition_AnyValueType struct {
	AnyValueType *FunctionAnyValueTypeDefinition `protobuf:"bytes,6,opt,name=any_value_type,json=anyValueType,oneof"`
}

type FunctionValueTypeDefinition_FunctionValueType

type FunctionValueTypeDefinition_FunctionValueType struct {
	FunctionValueType *FunctionTypeValueTypeDefinition `protobuf:"bytes,5,opt,name=function_value_type,json=functionValueType,oneof"`
}

type FunctionValueTypeDefinition_ListValueType

type FunctionValueTypeDefinition_ListValueType struct {
	ListValueType *FunctionListValueTypeDefinition `protobuf:"bytes,2,opt,name=list_value_type,json=listValueType,oneof"`
}

type FunctionValueTypeDefinition_MapValueType

type FunctionValueTypeDefinition_MapValueType struct {
	MapValueType *FunctionMapValueTypeDefinition `protobuf:"bytes,3,opt,name=map_value_type,json=mapValueType,oneof"`
}

type FunctionValueTypeDefinition_ObjectValueType

type FunctionValueTypeDefinition_ObjectValueType struct {
	ObjectValueType *FunctionObjectValueTypeDefinition `protobuf:"bytes,4,opt,name=object_value_type,json=objectValueType,oneof"`
}

type FunctionValueTypeDefinition_ScalarValueType

type FunctionValueTypeDefinition_ScalarValueType struct {
	ScalarValueType *FunctionScalarValueTypeDefinition `protobuf:"bytes,1,opt,name=scalar_value_type,json=scalarValueType,oneof"`
}

type FunctionVariadicParameter

type FunctionVariadicParameter struct {

	// The usage name for the parameter.
	// This will appear in logs and in tooling such as the
	// language server.
	Label string `protobuf:"bytes,1,opt,name=label" json:"label,omitempty"`
	// Type of the variadic parameter, an argument will be validated
	// against this type.
	Type *FunctionValueTypeDefinition `protobuf:"bytes,2,opt,name=type" json:"type,omitempty"`
	// Determines whether or not the variadic parameters
	// must all be of the same type.
	// This is false by default, meaning that variadic parameters
	// can be of any type.
	// The `type` field is only assessed if `single_type` is true.
	SingleType bool `protobuf:"varint,3,opt,name=single_type,json=singleType" json:"single_type,omitempty"`
	// A human-readable description of the parameter.
	// This will appear in logs and tooling such as the
	// language server.
	Description string `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	// A human-readable description of the parameter
	// that is formatted with markdown.
	// This will appear in usage documentation, logs and in
	// tooling such as the language server.
	FormattedDescription string `protobuf:"bytes,5,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// Determines whether or not an argument passed in for
	// this parameter can be null.
	AllowNullValue bool `protobuf:"varint,6,opt,name=allow_null_value,json=allowNullValue" json:"allow_null_value,omitempty"`
	// Determines whether or not the variadic parameters
	// are named arguments.
	// Named and positional arguments cannot be mixed.
	// If they are named arguments, all arguments do not need to be
	// of the same type.
	Named bool `protobuf:"varint,7,opt,name=named" json:"named,omitempty"`
	// contains filtered or unexported fields
}

FunctionVariadicParameter is a parameter type definition for variadic parameters at the end of a parameter list. A variadic parameter can be any number of arguments of any or a specific type.

func (*FunctionVariadicParameter) Descriptor deprecated

func (*FunctionVariadicParameter) Descriptor() ([]byte, []int)

Deprecated: Use FunctionVariadicParameter.ProtoReflect.Descriptor instead.

func (*FunctionVariadicParameter) GetAllowNullValue

func (x *FunctionVariadicParameter) GetAllowNullValue() bool

func (*FunctionVariadicParameter) GetDescription

func (x *FunctionVariadicParameter) GetDescription() string

func (*FunctionVariadicParameter) GetFormattedDescription

func (x *FunctionVariadicParameter) GetFormattedDescription() string

func (*FunctionVariadicParameter) GetLabel

func (x *FunctionVariadicParameter) GetLabel() string

func (*FunctionVariadicParameter) GetNamed

func (x *FunctionVariadicParameter) GetNamed() bool

func (*FunctionVariadicParameter) GetSingleType

func (x *FunctionVariadicParameter) GetSingleType() bool

func (*FunctionVariadicParameter) GetType

func (*FunctionVariadicParameter) ProtoMessage

func (*FunctionVariadicParameter) ProtoMessage()

func (*FunctionVariadicParameter) ProtoReflect

func (*FunctionVariadicParameter) Reset

func (x *FunctionVariadicParameter) Reset()

func (*FunctionVariadicParameter) String

func (x *FunctionVariadicParameter) String() string

type LinkChanges

type LinkChanges struct {
	ModifiedFields  []*FieldChange `protobuf:"bytes,1,rep,name=modified_fields,json=modifiedFields" json:"modified_fields,omitempty"`
	NewFields       []*FieldChange `protobuf:"bytes,2,rep,name=new_fields,json=newFields" json:"new_fields,omitempty"`
	RemovedFields   []string       `protobuf:"bytes,3,rep,name=removed_fields,json=removedFields" json:"removed_fields,omitempty"`
	UnchangedFields []string       `protobuf:"bytes,4,rep,name=unchanged_fields,json=unchangedFields" json:"unchanged_fields,omitempty"`
	// A list of field names for which changes
	// will be known when the host blueprint is deployed.
	FieldChangesKnownOnDeploy []string `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

LinkChanges provides a set of modified fields for a link between two resources. The link field changes represent a set of changes that will be made to the resources in the link relationship, these changes should be modelled as per the structure of the linkData that is persisted in the state of a blueprint instance. The linkData model should be organised by the resource type with a structure that is a close approximation of the actual changes that will be made to each resource during deployment in the upstream provider.

func (*LinkChanges) Descriptor deprecated

func (*LinkChanges) Descriptor() ([]byte, []int)

Deprecated: Use LinkChanges.ProtoReflect.Descriptor instead.

func (*LinkChanges) GetFieldChangesKnownOnDeploy

func (x *LinkChanges) GetFieldChangesKnownOnDeploy() []string

func (*LinkChanges) GetModifiedFields

func (x *LinkChanges) GetModifiedFields() []*FieldChange

func (*LinkChanges) GetNewFields

func (x *LinkChanges) GetNewFields() []*FieldChange

func (*LinkChanges) GetRemovedFields

func (x *LinkChanges) GetRemovedFields() []string

func (*LinkChanges) GetUnchangedFields

func (x *LinkChanges) GetUnchangedFields() []string

func (*LinkChanges) ProtoMessage

func (*LinkChanges) ProtoMessage()

func (*LinkChanges) ProtoReflect

func (x *LinkChanges) ProtoReflect() protoreflect.Message

func (*LinkChanges) Reset

func (x *LinkChanges) Reset()

func (*LinkChanges) String

func (x *LinkChanges) String() string

type PreciseResourceStatus

type PreciseResourceStatus int32

PreciseResourceStatus represents a more precise current state of a resource in a blueprint instance. This is used to allow the deploy engine to be more efficient in deploying a blueprint, by avoiding blocking on resource finalisation that isn't always needed to be able to successfully deploy the resources that are dependent on the resource in question.

const (
	// The status for when we can't determine
	// an accurate status for a resource.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_UNKNOWN PreciseResourceStatus = 0
	// The status for when an initial resource deployment
	// is currently in progress.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_CREATING PreciseResourceStatus = 1
	// The status for when a resource has been configured
	// successfully.
	// What this means is that the resource has been created
	// but is not yet in a stable state.
	// For example, an application in a container orchestration service
	// has been created but is not yet up and running.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_CONFIG_COMPLETE PreciseResourceStatus = 2
	// The status for when a resource has been deployed
	// successfully.
	// This is used when a resource is in a stable state.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_CREATED PreciseResourceStatus = 3
	// The status for when the first creation of a resource
	// failed.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_CREATE_FAILED PreciseResourceStatus = 4
	// The status for when another change in the same blueprint has failed
	// and the current resource that was successfully created is being rolled back.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_CREATE_ROLLING_BACK PreciseResourceStatus = 5
	// The status for when another change in the same blueprint has failed
	// and the current resource that was successfully created could not be rolled back.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_CREATE_ROLLBACK_FAILED PreciseResourceStatus = 6
	// The status for when another change in the same blueprint has failed
	// and the current resource that was successfully created has been rolled back.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_CREATE_ROLLBACK_COMPLETE PreciseResourceStatus = 7
	// The status for when a resource is in the process of being destroyed.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_DESTROYING PreciseResourceStatus = 8
	// The status for when a resource has been destroyed.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_DESTROYED PreciseResourceStatus = 9
	// The status for when the destruction of a resource fails.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_DESTROY_FAILED PreciseResourceStatus = 10
	// The status for when another change in the same blueprint has failed
	// and the current resource that was successfully removed is being rolled back.
	// This involves recreating the resource from the previous state.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_DESTROY_ROLLING_BACK PreciseResourceStatus = 11
	// The status for when another change in the same blueprint has failed
	// and the current resource that was successfully removed could not be
	// rolled back (recreated).
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_DESTROY_ROLLBACK_FAILED PreciseResourceStatus = 12
	// The status for when another change in the same blueprint has failed
	// and the current resource that was successfully removed
	// has been rolled back (recreated) but is not yet in a stable state.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_DESTROY_ROLLBACK_CONFIG_COMPLETE PreciseResourceStatus = 13
	// The status for when another change in the same blueprint has failed
	// and the current resource that was successfully
	// removed has been rolled back (recreated).
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_DESTROY_ROLLBACK_COMPLETE PreciseResourceStatus = 14
	// The status for when a resource is being updated.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_UPDATING PreciseResourceStatus = 15
	// The status for when a resource being updated has been configured
	// successfully.
	// What this means is that the resource has been updated
	// but is not yet in a stable state.
	// For example, an application in a container orchestration service
	// has been updated but the new version is not yet up and running.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_UPDATE_CONFIG_COMPLETE PreciseResourceStatus = 16
	// The status for when a resource has been successfully updated.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_UPDATED PreciseResourceStatus = 17
	// The status for when a resource has failed to update.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_UPDATE_FAILED PreciseResourceStatus = 18
	// The status for when another change in the same blueprint has failed
	// and the current resource that was successfully updated is being
	// rolled back to the previous state.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_UPDATE_ROLLING_BACK PreciseResourceStatus = 19
	// The status for when another change in the same blueprint has failed
	// and the current resource that was successfully updated could not be
	// rolled back to the previous state.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_UPDATE_ROLLBACK_FAILED PreciseResourceStatus = 20
	// The status for when another change in the same blueprint has failed
	// and the current resource that was successfully updated has been
	// rolled back to the previous state but is not yet in a stable state.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_UPDATE_ROLLBACK_CONFIG_COMPLETE PreciseResourceStatus = 21
	// The status for when another change in the same blueprint has failed
	// and the current resource that was successfully updated has been
	// rolled back to the previous state.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_UPDATE_ROLLBACK_COMPLETE PreciseResourceStatus = 22
	// The status for when a resource creation was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_CREATE_INTERRUPTED PreciseResourceStatus = 23
	// The status for when a resource update was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_UPDATE_INTERRUPTED PreciseResourceStatus = 24
	// The status for when a resource destruction was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	PreciseResourceStatus_PRECISE_RESOURCE_STATUS_DESTROY_INTERRUPTED PreciseResourceStatus = 25
)

func (PreciseResourceStatus) Descriptor

func (PreciseResourceStatus) Enum

func (PreciseResourceStatus) EnumDescriptor deprecated

func (PreciseResourceStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use PreciseResourceStatus.Descriptor instead.

func (PreciseResourceStatus) Number

func (PreciseResourceStatus) String

func (x PreciseResourceStatus) String() string

func (PreciseResourceStatus) Type

type ProvenanceState added in v0.2.0

type ProvenanceState struct {

	// A marker indicating the resource was provisioned by Bluelink.
	ProvisionedBy string `protobuf:"bytes,1,opt,name=provisioned_by,json=provisionedBy" json:"provisioned_by,omitempty"`
	// The version of the deploy engine that provisioned the resource.
	DeployEngineVersion string `protobuf:"bytes,2,opt,name=deploy_engine_version,json=deployEngineVersion" json:"deploy_engine_version,omitempty"`
	// The identifier for the provider plugin (e.g., "newstack-cloud/aws").
	ProviderPluginId string `protobuf:"bytes,3,opt,name=provider_plugin_id,json=providerPluginId" json:"provider_plugin_id,omitempty"`
	// The version of the provider plugin that provisioned the resource.
	ProviderPluginVersion string `protobuf:"bytes,4,opt,name=provider_plugin_version,json=providerPluginVersion" json:"provider_plugin_version,omitempty"`
	// The unix timestamp when the resource was provisioned.
	ProvisionedAt int64 `protobuf:"varint,5,opt,name=provisioned_at,json=provisionedAt" json:"provisioned_at,omitempty"`
	// contains filtered or unexported fields
}

ProvenanceState stores Bluelink provenance information for a resource.

func (*ProvenanceState) Descriptor deprecated added in v0.2.0

func (*ProvenanceState) Descriptor() ([]byte, []int)

Deprecated: Use ProvenanceState.ProtoReflect.Descriptor instead.

func (*ProvenanceState) GetDeployEngineVersion added in v0.2.0

func (x *ProvenanceState) GetDeployEngineVersion() string

func (*ProvenanceState) GetProviderPluginId added in v0.2.0

func (x *ProvenanceState) GetProviderPluginId() string

func (*ProvenanceState) GetProviderPluginVersion added in v0.2.0

func (x *ProvenanceState) GetProviderPluginVersion() string

func (*ProvenanceState) GetProvisionedAt added in v0.2.0

func (x *ProvenanceState) GetProvisionedAt() int64

func (*ProvenanceState) GetProvisionedBy added in v0.2.0

func (x *ProvenanceState) GetProvisionedBy() string

func (*ProvenanceState) ProtoMessage added in v0.2.0

func (*ProvenanceState) ProtoMessage()

func (*ProvenanceState) ProtoReflect added in v0.2.0

func (x *ProvenanceState) ProtoReflect() protoreflect.Message

func (*ProvenanceState) Reset added in v0.2.0

func (x *ProvenanceState) Reset()

func (*ProvenanceState) String added in v0.2.0

func (x *ProvenanceState) String() string

type ProviderContext

type ProviderContext struct {

	// Configuration parameters specifically for the provider.
	ProviderConfigVariables map[string]*schemapb.ScalarValue `` /* 199-byte string literal not displayed */
	// Context-wide variables for the current deploy engine run.
	ContextVariables map[string]*schemapb.ScalarValue `` /* 176-byte string literal not displayed */
	// Configuration for resource tagging behavior.
	TaggingConfig *TaggingConfig `protobuf:"bytes,3,opt,name=tagging_config,json=taggingConfig" json:"tagging_config,omitempty"`
	// contains filtered or unexported fields
}

ProviderContext holds the environment configuration for the current provider.

func (*ProviderContext) Descriptor deprecated

func (*ProviderContext) Descriptor() ([]byte, []int)

Deprecated: Use ProviderContext.ProtoReflect.Descriptor instead.

func (*ProviderContext) GetContextVariables

func (x *ProviderContext) GetContextVariables() map[string]*schemapb.ScalarValue

func (*ProviderContext) GetProviderConfigVariables

func (x *ProviderContext) GetProviderConfigVariables() map[string]*schemapb.ScalarValue

func (*ProviderContext) GetTaggingConfig added in v0.2.0

func (x *ProviderContext) GetTaggingConfig() *TaggingConfig

func (*ProviderContext) ProtoMessage

func (*ProviderContext) ProtoMessage()

func (*ProviderContext) ProtoReflect

func (x *ProviderContext) ProtoReflect() protoreflect.Message

func (*ProviderContext) Reset

func (x *ProviderContext) Reset()

func (*ProviderContext) String

func (x *ProviderContext) String() string

type ResolvedResource

type ResolvedResource struct {
	Type         *ResourceType              `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
	Description  *schemapb.MappingNode      `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"`
	Metadata     *ResolvedResourceMetadata  `protobuf:"bytes,3,opt,name=metadata" json:"metadata,omitempty"`
	Condition    *ResolvedResourceCondition `protobuf:"bytes,4,opt,name=condition" json:"condition,omitempty"`
	LinkSelector *schemapb.LinkSelector     `protobuf:"bytes,5,opt,name=link_selector,json=linkSelector" json:"link_selector,omitempty"`
	Spec         *schemapb.MappingNode      `protobuf:"bytes,6,opt,name=spec" json:"spec,omitempty"`
	// contains filtered or unexported fields
}

ResolvedResource provides a version of a resource for which all ${..} substitutions have been applied. Mapping nodes replace StringOrSubstitutions from the blueprint schema representation of the resource.

func (*ResolvedResource) Descriptor deprecated

func (*ResolvedResource) Descriptor() ([]byte, []int)

Deprecated: Use ResolvedResource.ProtoReflect.Descriptor instead.

func (*ResolvedResource) GetCondition

func (x *ResolvedResource) GetCondition() *ResolvedResourceCondition

func (*ResolvedResource) GetDescription

func (x *ResolvedResource) GetDescription() *schemapb.MappingNode

func (*ResolvedResource) GetLinkSelector

func (x *ResolvedResource) GetLinkSelector() *schemapb.LinkSelector

func (*ResolvedResource) GetMetadata

func (x *ResolvedResource) GetMetadata() *ResolvedResourceMetadata

func (*ResolvedResource) GetSpec

func (x *ResolvedResource) GetSpec() *schemapb.MappingNode

func (*ResolvedResource) GetType

func (x *ResolvedResource) GetType() *ResourceType

func (*ResolvedResource) ProtoMessage

func (*ResolvedResource) ProtoMessage()

func (*ResolvedResource) ProtoReflect

func (x *ResolvedResource) ProtoReflect() protoreflect.Message

func (*ResolvedResource) Reset

func (x *ResolvedResource) Reset()

func (*ResolvedResource) String

func (x *ResolvedResource) String() string

type ResolvedResourceCondition

type ResolvedResourceCondition struct {

	// A list of conditions that must all be true.
	And []*ResolvedResourceCondition `protobuf:"bytes,1,rep,name=and" json:"and,omitempty"`
	// A list of conditions where at least one must be true.
	Or []*ResolvedResourceCondition `protobuf:"bytes,2,rep,name=or" json:"or,omitempty"`
	// A condition that will be negated.
	Not *ResolvedResourceCondition `protobuf:"bytes,3,opt,name=not" json:"not,omitempty"`
	// A condition expression that is expected to be a substitution that
	// resolves to a boolean.
	StringValue *schemapb.MappingNode `protobuf:"bytes,4,opt,name=string_value,json=stringValue" json:"string_value,omitempty"`
	// contains filtered or unexported fields
}

ResolvedResourceCondition provides a resolved version of the condition for a resource where all substitutions have been applied.

func (*ResolvedResourceCondition) Descriptor deprecated

func (*ResolvedResourceCondition) Descriptor() ([]byte, []int)

Deprecated: Use ResolvedResourceCondition.ProtoReflect.Descriptor instead.

func (*ResolvedResourceCondition) GetAnd

func (*ResolvedResourceCondition) GetNot

func (*ResolvedResourceCondition) GetOr

func (*ResolvedResourceCondition) GetStringValue

func (x *ResolvedResourceCondition) GetStringValue() *schemapb.MappingNode

func (*ResolvedResourceCondition) ProtoMessage

func (*ResolvedResourceCondition) ProtoMessage()

func (*ResolvedResourceCondition) ProtoReflect

func (*ResolvedResourceCondition) Reset

func (x *ResolvedResourceCondition) Reset()

func (*ResolvedResourceCondition) String

func (x *ResolvedResourceCondition) String() string

type ResolvedResourceMetadata

type ResolvedResourceMetadata struct {
	DisplayName *schemapb.MappingNode `protobuf:"bytes,1,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
	Annotations *schemapb.MappingNode `protobuf:"bytes,2,opt,name=annotations" json:"annotations,omitempty"`
	Labels      map[string]string     `` /* 132-byte string literal not displayed */
	Custom      *schemapb.MappingNode `protobuf:"bytes,4,opt,name=custom" json:"custom,omitempty"`
	// contains filtered or unexported fields
}

ResolvedResourceMetadata provides a resolved version of the metadata for a resource where all substitutions have been applied.

func (*ResolvedResourceMetadata) Descriptor deprecated

func (*ResolvedResourceMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ResolvedResourceMetadata.ProtoReflect.Descriptor instead.

func (*ResolvedResourceMetadata) GetAnnotations

func (x *ResolvedResourceMetadata) GetAnnotations() *schemapb.MappingNode

func (*ResolvedResourceMetadata) GetCustom

func (*ResolvedResourceMetadata) GetDisplayName

func (x *ResolvedResourceMetadata) GetDisplayName() *schemapb.MappingNode

func (*ResolvedResourceMetadata) GetLabels

func (x *ResolvedResourceMetadata) GetLabels() map[string]string

func (*ResolvedResourceMetadata) ProtoMessage

func (*ResolvedResourceMetadata) ProtoMessage()

func (*ResolvedResourceMetadata) ProtoReflect

func (x *ResolvedResourceMetadata) ProtoReflect() protoreflect.Message

func (*ResolvedResourceMetadata) Reset

func (x *ResolvedResourceMetadata) Reset()

func (*ResolvedResourceMetadata) String

func (x *ResolvedResourceMetadata) String() string

type ResourceCommonTerminalInfo

type ResourceCommonTerminalInfo struct {
	IsCommonTerminal bool `protobuf:"varint,1,opt,name=is_common_terminal,json=isCommonTerminal" json:"is_common_terminal,omitempty"`
	// contains filtered or unexported fields
}

ResourceCommonTerminalInfo holds information about whether a given resource type is expected to have a common use-case as a terminal resource.

func (*ResourceCommonTerminalInfo) Descriptor deprecated

func (*ResourceCommonTerminalInfo) Descriptor() ([]byte, []int)

Deprecated: Use ResourceCommonTerminalInfo.ProtoReflect.Descriptor instead.

func (*ResourceCommonTerminalInfo) GetIsCommonTerminal

func (x *ResourceCommonTerminalInfo) GetIsCommonTerminal() bool

func (*ResourceCommonTerminalInfo) ProtoMessage

func (*ResourceCommonTerminalInfo) ProtoMessage()

func (*ResourceCommonTerminalInfo) ProtoReflect

func (*ResourceCommonTerminalInfo) Reset

func (x *ResourceCommonTerminalInfo) Reset()

func (*ResourceCommonTerminalInfo) String

func (x *ResourceCommonTerminalInfo) String() string

type ResourceCompletionDurations

type ResourceCompletionDurations struct {

	// The duration in milliseconds for the resource to be configured.
	// This will only be present of the resource has reached config complete status.
	ConfigCompleteDuration *wrapperspb.DoubleValue `protobuf:"bytes,1,opt,name=config_complete_duration,json=configCompleteDuration" json:"config_complete_duration,omitempty"`
	// The duration in milliseconds for the resource change to reach the final status.
	TotalDuration *wrapperspb.DoubleValue `protobuf:"bytes,2,opt,name=total_duration,json=totalDuration" json:"total_duration,omitempty"`
	// A list of durations in milliseconds for each attempt to deploy the resource.
	// Attempt durations are in order as per the "attempt" field in a status update message.
	AttemptDurations []float64 `protobuf:"fixed64,3,rep,packed,name=attempt_durations,json=attemptDurations" json:"attempt_durations,omitempty"`
	// contains filtered or unexported fields
}

ResourceCompletionDurations holds duration information for the deployment of a resource change.

func (*ResourceCompletionDurations) Descriptor deprecated

func (*ResourceCompletionDurations) Descriptor() ([]byte, []int)

Deprecated: Use ResourceCompletionDurations.ProtoReflect.Descriptor instead.

func (*ResourceCompletionDurations) GetAttemptDurations

func (x *ResourceCompletionDurations) GetAttemptDurations() []float64

func (*ResourceCompletionDurations) GetConfigCompleteDuration

func (x *ResourceCompletionDurations) GetConfigCompleteDuration() *wrapperspb.DoubleValue

func (*ResourceCompletionDurations) GetTotalDuration

func (x *ResourceCompletionDurations) GetTotalDuration() *wrapperspb.DoubleValue

func (*ResourceCompletionDurations) ProtoMessage

func (*ResourceCompletionDurations) ProtoMessage()

func (*ResourceCompletionDurations) ProtoReflect

func (*ResourceCompletionDurations) Reset

func (x *ResourceCompletionDurations) Reset()

func (*ResourceCompletionDurations) String

func (x *ResourceCompletionDurations) String() string

type ResourceDefinitionsSchema

type ResourceDefinitionsSchema struct {

	// The type of the resource element definition.
	Type string `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
	// A human-readable label for the resource element definition.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// A description for the resource definition without any formatting.
	Description string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	// A description for the resource definition with markdown formatting.
	FormattedDescription string `protobuf:"bytes,4,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// A mapping of the attribute types for a resource definition
	// object element.
	Attributes map[string]*ResourceDefinitionsSchema `` /* 140-byte string literal not displayed */
	// The schema for the items in a a resource definition array element.
	Items *ResourceDefinitionsSchema `protobuf:"bytes,6,opt,name=items" json:"items,omitempty"`
	// The schema for the values in a resource definition map element.
	// Keys are always strings.
	MapValues *ResourceDefinitionsSchema `protobuf:"bytes,7,opt,name=map_values,json=mapValues" json:"map_values,omitempty"`
	// A list of possible schemas for a resource definition item.
	// This is to be used with the "union" type.
	OneOf []*ResourceDefinitionsSchema `protobuf:"bytes,8,rep,name=one_of,json=oneOf" json:"one_of,omitempty"`
	// A list of required attributes for a resource definition object element.
	Required []string `protobuf:"bytes,9,rep,name=required" json:"required,omitempty"`
	// Specifies whether the resource definition schema can be null.
	Nullable bool `protobuf:"varint,10,opt,name=nullable" json:"nullable,omitempty"`
	// Holds the default value for a resource spec schema,
	// this will be populated in the `Resource.Spec.*` mapping node
	// if the resource spec is missing a value for a specific attribute
	// or item in the spec.
	// The default value will not be used if the attribute value in a given resource spec is null
	// and the schema is nullable, a null pointer should not be used
	// for an empty value, pointers should be set when you want to explicitly
	// set a value to null.
	// The default value will not be used for computed value in a resource spec.
	DefaultValue *schemapb.MappingNode `protobuf:"bytes,11,opt,name=default_value,json=defaultValue" json:"default_value,omitempty"`
	// Golds a list of examples for the resource definition element.
	// Examples are useful for documentation and tooling.
	Examples []*schemapb.MappingNode `protobuf:"bytes,12,rep,name=examples" json:"examples,omitempty"`
	// Specifies whether the value is computed by the provider and should not
	// be set by the user.
	// Computed values are expected to be populated by provider plugin resource
	// implementations in the deployment process.
	Computed bool `protobuf:"varint,13,opt,name=computed" json:"computed,omitempty"`
	// Specifies whether the resource must be recreated if a change to the field
	// is detected in the resource state.
	// This is only used for user-provided values, it will be ignored
	// for computed values.
	MustRecreate bool `protobuf:"varint,14,opt,name=must_recreate,json=mustRecreate" json:"must_recreate,omitempty"`
	// Specifies whether the field for the schema is sensitive
	// and should not be logged or displayed in output.
	Sensitive bool `protobuf:"varint,15,opt,name=sensitive" json:"sensitive,omitempty"`
	// Specifies whether a field defined by this schema should be ignored
	// when checking for drift in the resource state between the resource in
	// the upstream provider and the resource in the blueprint instance state.
	IgnoreDrift bool `protobuf:"varint,16,opt,name=ignore_drift,json=ignoreDrift" json:"ignore_drift,omitempty"`
	// Specifies whether a computed value should be included in the drift
	// checking process.
	// This is only applicable for schemas with the `Computed` field set to true,
	// this value has no effect on user-defined values.
	// Computed values are excluded from the drift checking process by default.
	TrackDrift bool `protobuf:"varint,17,opt,name=track_drift,json=trackDrift" json:"track_drift,omitempty"`
	// Specifies a field name to sort array items by before comparison.
	// This is only applicable for schemas with Type set to "array" where items are objects.
	// When set, array elements will be sorted by the specified field's string value
	// before change detection, ensuring order-independent comparison.
	// This is useful for arrays like tags where the logical identity is a key field
	// but the order may vary between the blueprint spec and external state.
	// Example: For tags like [{key: "env", value: "prod"}, {key: "name", value: "foo"}],
	// setting sort_array_by_field to "key" ensures consistent comparison regardless of order.
	SortArrayByField string `protobuf:"bytes,18,opt,name=sort_array_by_field,json=sortArrayByField" json:"sort_array_by_field,omitempty"`
	// contains filtered or unexported fields
}

ResourceDefinitionsSchema provides a schema that can be used to validate a resource spec or output state.

func (*ResourceDefinitionsSchema) Descriptor deprecated

func (*ResourceDefinitionsSchema) Descriptor() ([]byte, []int)

Deprecated: Use ResourceDefinitionsSchema.ProtoReflect.Descriptor instead.

func (*ResourceDefinitionsSchema) GetAttributes

func (*ResourceDefinitionsSchema) GetComputed

func (x *ResourceDefinitionsSchema) GetComputed() bool

func (*ResourceDefinitionsSchema) GetDefaultValue

func (x *ResourceDefinitionsSchema) GetDefaultValue() *schemapb.MappingNode

func (*ResourceDefinitionsSchema) GetDescription

func (x *ResourceDefinitionsSchema) GetDescription() string

func (*ResourceDefinitionsSchema) GetExamples

func (x *ResourceDefinitionsSchema) GetExamples() []*schemapb.MappingNode

func (*ResourceDefinitionsSchema) GetFormattedDescription

func (x *ResourceDefinitionsSchema) GetFormattedDescription() string

func (*ResourceDefinitionsSchema) GetIgnoreDrift

func (x *ResourceDefinitionsSchema) GetIgnoreDrift() bool

func (*ResourceDefinitionsSchema) GetItems

func (*ResourceDefinitionsSchema) GetLabel

func (x *ResourceDefinitionsSchema) GetLabel() string

func (*ResourceDefinitionsSchema) GetMapValues

func (*ResourceDefinitionsSchema) GetMustRecreate

func (x *ResourceDefinitionsSchema) GetMustRecreate() bool

func (*ResourceDefinitionsSchema) GetNullable

func (x *ResourceDefinitionsSchema) GetNullable() bool

func (*ResourceDefinitionsSchema) GetOneOf

func (*ResourceDefinitionsSchema) GetRequired

func (x *ResourceDefinitionsSchema) GetRequired() []string

func (*ResourceDefinitionsSchema) GetSensitive

func (x *ResourceDefinitionsSchema) GetSensitive() bool

func (*ResourceDefinitionsSchema) GetSortArrayByField added in v0.2.0

func (x *ResourceDefinitionsSchema) GetSortArrayByField() string

func (*ResourceDefinitionsSchema) GetTrackDrift

func (x *ResourceDefinitionsSchema) GetTrackDrift() bool

func (*ResourceDefinitionsSchema) GetType

func (x *ResourceDefinitionsSchema) GetType() string

func (*ResourceDefinitionsSchema) ProtoMessage

func (*ResourceDefinitionsSchema) ProtoMessage()

func (*ResourceDefinitionsSchema) ProtoReflect

func (*ResourceDefinitionsSchema) Reset

func (x *ResourceDefinitionsSchema) Reset()

func (*ResourceDefinitionsSchema) String

func (x *ResourceDefinitionsSchema) String() string

type ResourceHasStabilisedRequest

type ResourceHasStabilisedRequest struct {
	ResourceType *ResourceType `protobuf:"bytes,1,opt,name=resource_type,json=resourceType" json:"resource_type,omitempty"`
	// The ID of the host making the request
	// to the provider.
	HostId           string                 `protobuf:"bytes,2,opt,name=host_id,json=hostId" json:"host_id,omitempty"`
	InstanceId       string                 `protobuf:"bytes,3,opt,name=instance_id,json=instanceId" json:"instance_id,omitempty"`
	InstanceName     string                 `protobuf:"bytes,4,opt,name=instance_name,json=instanceName" json:"instance_name,omitempty"`
	ResourceId       string                 `protobuf:"bytes,5,opt,name=resource_id,json=resourceId" json:"resource_id,omitempty"`
	ResourceSpec     *schemapb.MappingNode  `protobuf:"bytes,6,opt,name=resource_spec,json=resourceSpec" json:"resource_spec,omitempty"`
	ResourceMetadata *ResourceMetadataState `protobuf:"bytes,7,opt,name=resource_metadata,json=resourceMetadata" json:"resource_metadata,omitempty"`
	Context          *ProviderContext       `protobuf:"bytes,8,opt,name=context" json:"context,omitempty"`
	// contains filtered or unexported fields
}

ResourceHasStabilisedRequest is the request that contains the input data needed for a resource to determine if it has stabilised after being deployed.

func (*ResourceHasStabilisedRequest) Descriptor deprecated

func (*ResourceHasStabilisedRequest) Descriptor() ([]byte, []int)

Deprecated: Use ResourceHasStabilisedRequest.ProtoReflect.Descriptor instead.

func (*ResourceHasStabilisedRequest) GetContext

func (*ResourceHasStabilisedRequest) GetHostId

func (x *ResourceHasStabilisedRequest) GetHostId() string

func (*ResourceHasStabilisedRequest) GetInstanceId

func (x *ResourceHasStabilisedRequest) GetInstanceId() string

func (*ResourceHasStabilisedRequest) GetInstanceName

func (x *ResourceHasStabilisedRequest) GetInstanceName() string

func (*ResourceHasStabilisedRequest) GetResourceId

func (x *ResourceHasStabilisedRequest) GetResourceId() string

func (*ResourceHasStabilisedRequest) GetResourceMetadata

func (x *ResourceHasStabilisedRequest) GetResourceMetadata() *ResourceMetadataState

func (*ResourceHasStabilisedRequest) GetResourceSpec

func (x *ResourceHasStabilisedRequest) GetResourceSpec() *schemapb.MappingNode

func (*ResourceHasStabilisedRequest) GetResourceType

func (x *ResourceHasStabilisedRequest) GetResourceType() *ResourceType

func (*ResourceHasStabilisedRequest) ProtoMessage

func (*ResourceHasStabilisedRequest) ProtoMessage()

func (*ResourceHasStabilisedRequest) ProtoReflect

func (*ResourceHasStabilisedRequest) Reset

func (x *ResourceHasStabilisedRequest) Reset()

func (*ResourceHasStabilisedRequest) String

type ResourceHasStabilisedResponse

type ResourceHasStabilisedResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*ResourceHasStabilisedResponse_ResourceStabilisationInfo
	//	*ResourceHasStabilisedResponse_ErrorResponse
	Response isResourceHasStabilisedResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

ResourceHasStabilisedResponse is the response containing the result of checking if a resource has stabilised.

func (*ResourceHasStabilisedResponse) Descriptor deprecated

func (*ResourceHasStabilisedResponse) Descriptor() ([]byte, []int)

Deprecated: Use ResourceHasStabilisedResponse.ProtoReflect.Descriptor instead.

func (*ResourceHasStabilisedResponse) GetErrorResponse

func (x *ResourceHasStabilisedResponse) GetErrorResponse() *ErrorResponse

func (*ResourceHasStabilisedResponse) GetResourceStabilisationInfo

func (x *ResourceHasStabilisedResponse) GetResourceStabilisationInfo() *ResourceStabilisationInfo

func (*ResourceHasStabilisedResponse) GetResponse

func (x *ResourceHasStabilisedResponse) GetResponse() isResourceHasStabilisedResponse_Response

func (*ResourceHasStabilisedResponse) ProtoMessage

func (*ResourceHasStabilisedResponse) ProtoMessage()

func (*ResourceHasStabilisedResponse) ProtoReflect

func (*ResourceHasStabilisedResponse) Reset

func (x *ResourceHasStabilisedResponse) Reset()

func (*ResourceHasStabilisedResponse) String

type ResourceHasStabilisedResponse_ErrorResponse

type ResourceHasStabilisedResponse_ErrorResponse struct {
	ErrorResponse *ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type ResourceHasStabilisedResponse_ResourceStabilisationInfo

type ResourceHasStabilisedResponse_ResourceStabilisationInfo struct {
	ResourceStabilisationInfo *ResourceStabilisationInfo `protobuf:"bytes,1,opt,name=resource_stabilisation_info,json=resourceStabilisationInfo,oneof"`
}

type ResourceInfo

type ResourceInfo struct {

	// The ID of a resource when in the context
	// of a blueprint instance when deploying or staging changes.
	// Sometimes staging changes is independent of an instance and is used to compare
	// two vesions of a blueprint in which
	// case the resource ID will be empty.
	ResourceId string `protobuf:"bytes,1,opt,name=resource_id,json=resourceId" json:"resource_id,omitempty"`
	// The name of the resource in the blueprint spec.
	// This is useful for new resources that do not have any current resource state.
	ResourceName string `protobuf:"bytes,2,opt,name=resource_name,json=resourceName" json:"resource_name,omitempty"`
	// The ID of the blueprint instance
	// that the current resource belongs to.
	// This could be empty if the resource is being staged
	// for an initial deployment.
	InstanceId string `protobuf:"bytes,3,opt,name=instance_id,json=instanceId" json:"instance_id,omitempty"`
	// The current state of the resource
	// for which changes are being staged.
	// If this is null, it means that the resource is new and does not have
	// a current state.
	CurrentResourceState *ResourceState `protobuf:"bytes,4,opt,name=current_resource_state,json=currentResourceState" json:"current_resource_state,omitempty"`
	// A version of a resource for which all ${..}
	// substitutions have been applied.
	ResourceWithResolvedSubs *ResolvedResource `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

ResourceInfo provides all the information needed for a resource including the blueprint schema data with annotations, labels and the spec as a core mapping node.

func (*ResourceInfo) Descriptor deprecated

func (*ResourceInfo) Descriptor() ([]byte, []int)

Deprecated: Use ResourceInfo.ProtoReflect.Descriptor instead.

func (*ResourceInfo) GetCurrentResourceState

func (x *ResourceInfo) GetCurrentResourceState() *ResourceState

func (*ResourceInfo) GetInstanceId

func (x *ResourceInfo) GetInstanceId() string

func (*ResourceInfo) GetResourceId

func (x *ResourceInfo) GetResourceId() string

func (*ResourceInfo) GetResourceName

func (x *ResourceInfo) GetResourceName() string

func (*ResourceInfo) GetResourceWithResolvedSubs

func (x *ResourceInfo) GetResourceWithResolvedSubs() *ResolvedResource

func (*ResourceInfo) ProtoMessage

func (*ResourceInfo) ProtoMessage()

func (*ResourceInfo) ProtoReflect

func (x *ResourceInfo) ProtoReflect() protoreflect.Message

func (*ResourceInfo) Reset

func (x *ResourceInfo) Reset()

func (*ResourceInfo) String

func (x *ResourceInfo) String() string

type ResourceMetadataState

type ResourceMetadataState struct {
	DisplayName string                           `protobuf:"bytes,1,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
	Annotations map[string]*schemapb.MappingNode `` /* 142-byte string literal not displayed */
	Labels      map[string]string                `` /* 132-byte string literal not displayed */
	Custom      *schemapb.MappingNode            `protobuf:"bytes,4,opt,name=custom" json:"custom,omitempty"`
	// contains filtered or unexported fields
}

ResourceMetadataState holds metadata for a resource that is derived from a source blueprint.

func (*ResourceMetadataState) Descriptor deprecated

func (*ResourceMetadataState) Descriptor() ([]byte, []int)

Deprecated: Use ResourceMetadataState.ProtoReflect.Descriptor instead.

func (*ResourceMetadataState) GetAnnotations

func (x *ResourceMetadataState) GetAnnotations() map[string]*schemapb.MappingNode

func (*ResourceMetadataState) GetCustom

func (x *ResourceMetadataState) GetCustom() *schemapb.MappingNode

func (*ResourceMetadataState) GetDisplayName

func (x *ResourceMetadataState) GetDisplayName() string

func (*ResourceMetadataState) GetLabels

func (x *ResourceMetadataState) GetLabels() map[string]string

func (*ResourceMetadataState) ProtoMessage

func (*ResourceMetadataState) ProtoMessage()

func (*ResourceMetadataState) ProtoReflect

func (x *ResourceMetadataState) ProtoReflect() protoreflect.Message

func (*ResourceMetadataState) Reset

func (x *ResourceMetadataState) Reset()

func (*ResourceMetadataState) String

func (x *ResourceMetadataState) String() string

type ResourceSpecDefinition

type ResourceSpecDefinition struct {

	// The schema for the resource specification.
	Schema *ResourceDefinitionsSchema `protobuf:"bytes,1,opt,name=schema" json:"schema,omitempty"`
	// The name of the field in the resource spec that
	// holds the third-party ID for the resource.
	// This is used to resolve references to a resource in
	// a blueprint where only the name of the resource is specified.
	// For example, references such as `resources.processOrderFunction`
	// or `processOrderFunction` should resolve to the ID of the resource in
	// the blueprint.
	// The ID field must be a top-level property of the resource spec schema.
	IdField string `protobuf:"bytes,2,opt,name=id_field,json=idField" json:"id_field,omitempty"`
	// Specifies whether the resource should be destroyed before it is created
	// as a part of the deployment process when a resource must be recreated
	// to apply a set of changes.
	DestroyBeforeCreate bool `protobuf:"varint,3,opt,name=destroy_before_create,json=destroyBeforeCreate" json:"destroy_before_create,omitempty"`
	// Indicates how the resource type supports external tagging.
	TaggingSupport TaggingSupport `` /* 131-byte string literal not displayed */
	// contains filtered or unexported fields
}

ResourceSpecDefinition provides a definition for a resource spec that is used for state management, validation, docs and tooling.

func (*ResourceSpecDefinition) Descriptor deprecated

func (*ResourceSpecDefinition) Descriptor() ([]byte, []int)

Deprecated: Use ResourceSpecDefinition.ProtoReflect.Descriptor instead.

func (*ResourceSpecDefinition) GetDestroyBeforeCreate

func (x *ResourceSpecDefinition) GetDestroyBeforeCreate() bool

func (*ResourceSpecDefinition) GetIdField

func (x *ResourceSpecDefinition) GetIdField() string

func (*ResourceSpecDefinition) GetSchema

func (*ResourceSpecDefinition) GetTaggingSupport added in v0.2.0

func (x *ResourceSpecDefinition) GetTaggingSupport() TaggingSupport

func (*ResourceSpecDefinition) ProtoMessage

func (*ResourceSpecDefinition) ProtoMessage()

func (*ResourceSpecDefinition) ProtoReflect

func (x *ResourceSpecDefinition) ProtoReflect() protoreflect.Message

func (*ResourceSpecDefinition) Reset

func (x *ResourceSpecDefinition) Reset()

func (*ResourceSpecDefinition) String

func (x *ResourceSpecDefinition) String() string

type ResourceStabilisationInfo

type ResourceStabilisationInfo struct {
	Stabilised bool `protobuf:"varint,1,opt,name=stabilised" json:"stabilised,omitempty"`
	// contains filtered or unexported fields
}

ResourceStabilisationInfo provides information about whether a resource has stabilised after being deployed.

func (*ResourceStabilisationInfo) Descriptor deprecated

func (*ResourceStabilisationInfo) Descriptor() ([]byte, []int)

Deprecated: Use ResourceStabilisationInfo.ProtoReflect.Descriptor instead.

func (*ResourceStabilisationInfo) GetStabilised

func (x *ResourceStabilisationInfo) GetStabilised() bool

func (*ResourceStabilisationInfo) ProtoMessage

func (*ResourceStabilisationInfo) ProtoMessage()

func (*ResourceStabilisationInfo) ProtoReflect

func (*ResourceStabilisationInfo) Reset

func (x *ResourceStabilisationInfo) Reset()

func (*ResourceStabilisationInfo) String

func (x *ResourceStabilisationInfo) String() string

type ResourceState

type ResourceState struct {

	// A globally unique identifier for the resource.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The logical name of the resource in the blueprint.
	Name string `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	// The type of the resource as defined in the source blueprint.
	Type string `protobuf:"bytes,3,opt,name=type" json:"type,omitempty"`
	// The name of the resource template in the source blueprint
	// that the resource is derived from.
	// This will be empty if the resource is not derived from a resource template.
	TemplateName  string                `protobuf:"bytes,4,opt,name=template_name,json=templateName" json:"template_name,omitempty"`
	InstanceId    string                `protobuf:"bytes,5,opt,name=instance_id,json=instanceId" json:"instance_id,omitempty"`
	Status        ResourceStatus        `protobuf:"varint,6,opt,name=status,enum=sharedtypesv1.ResourceStatus" json:"status,omitempty"`
	PreciseStatus PreciseResourceStatus `` /* 135-byte string literal not displayed */
	// The unix timestamp for when the resource deployment status was last updated.
	LastStatusUpdateTimestamp int64 `` /* 134-byte string literal not displayed */
	// The unix timestamp for when the resource was last deployed.
	LastDeployedTimestamp int64 `protobuf:"varint,9,opt,name=last_deployed_timestamp,json=lastDeployedTimestamp" json:"last_deployed_timestamp,omitempty"`
	// The unix timestamp for when an attempt was last made to deploy the resource.
	LastDeployAttemptTimestamp int64 `` /* 138-byte string literal not displayed */
	// The resolved resource spec for the currently deployed
	// version of the resource along with computed fields derived
	// from the deployed resource in the provider.
	SpecData *schemapb.MappingNode `protobuf:"bytes,11,opt,name=spec_data,json=specData" json:"spec_data,omitempty"`
	// A human-friendly description of the resource derived from a source blueprint.
	Description string `protobuf:"bytes,12,opt,name=description" json:"description,omitempty"`
	// Metadata for the resource that is derived from a source blueprint
	// that includes additional information that allows for extensions built on top
	// of the blueprint framework along with the storage of labels, annotations and a
	// human-friendly display name for the resource.
	Metadata *ResourceMetadataState `protobuf:"bytes,13,opt,name=metadata" json:"metadata,omitempty"`
	// A list of resource names that the response depends on,
	// this dependency is derived from "hard" links, references and the use of the dependsOn
	// property in the source blueprint.
	DependsOnResources []string `protobuf:"bytes,14,rep,name=depends_on_resources,json=dependsOnResources" json:"depends_on_resources,omitempty"`
	// A list of child blueprint names that the resource depends on.
	// This dependency is derived from references in the source blueprint.
	DependsOnChildren []string `protobuf:"bytes,15,rep,name=depends_on_children,json=dependsOnChildren" json:"depends_on_children,omitempty"`
	// A list of the latest reasons for failure in deploying a resource,
	// this only ever holds the results of the latest deployment attempt.
	FailureReasons []string `protobuf:"bytes,16,rep,name=failure_reasons,json=failureReasons" json:"failure_reasons,omitempty"`
	// Indicates whether or not the resource state has drifted
	// due to changes in the upstream provider.
	Drifted bool `protobuf:"varint,17,opt,name=drifted" json:"drifted,omitempty"`
	// The unix timestamp when drift was last detected.
	LastDriftDetectedTimestamp *wrapperspb.Int64Value `` /* 137-byte string literal not displayed */
	// Holds the duration information for the latest deployment of the resource.
	Durations *ResourceCompletionDurations `protobuf:"bytes,19,opt,name=durations" json:"durations,omitempty"`
	// System-generated metadata for the resource including provenance information.
	SystemMetadata *SystemMetadataState `protobuf:"bytes,20,opt,name=system_metadata,json=systemMetadata" json:"system_metadata,omitempty"`
	// contains filtered or unexported fields
}

ResourceState represents the current state of a resource in a blueprint instance. This includes the status, derived data from the upstream resource provider along with reasons for failure when a resource is in a failed state.

func (*ResourceState) Descriptor deprecated

func (*ResourceState) Descriptor() ([]byte, []int)

Deprecated: Use ResourceState.ProtoReflect.Descriptor instead.

func (*ResourceState) GetDependsOnChildren

func (x *ResourceState) GetDependsOnChildren() []string

func (*ResourceState) GetDependsOnResources

func (x *ResourceState) GetDependsOnResources() []string

func (*ResourceState) GetDescription

func (x *ResourceState) GetDescription() string

func (*ResourceState) GetDrifted

func (x *ResourceState) GetDrifted() bool

func (*ResourceState) GetDurations

func (x *ResourceState) GetDurations() *ResourceCompletionDurations

func (*ResourceState) GetFailureReasons

func (x *ResourceState) GetFailureReasons() []string

func (*ResourceState) GetId

func (x *ResourceState) GetId() string

func (*ResourceState) GetInstanceId

func (x *ResourceState) GetInstanceId() string

func (*ResourceState) GetLastDeployAttemptTimestamp

func (x *ResourceState) GetLastDeployAttemptTimestamp() int64

func (*ResourceState) GetLastDeployedTimestamp

func (x *ResourceState) GetLastDeployedTimestamp() int64

func (*ResourceState) GetLastDriftDetectedTimestamp

func (x *ResourceState) GetLastDriftDetectedTimestamp() *wrapperspb.Int64Value

func (*ResourceState) GetLastStatusUpdateTimestamp

func (x *ResourceState) GetLastStatusUpdateTimestamp() int64

func (*ResourceState) GetMetadata

func (x *ResourceState) GetMetadata() *ResourceMetadataState

func (*ResourceState) GetName

func (x *ResourceState) GetName() string

func (*ResourceState) GetPreciseStatus

func (x *ResourceState) GetPreciseStatus() PreciseResourceStatus

func (*ResourceState) GetSpecData

func (x *ResourceState) GetSpecData() *schemapb.MappingNode

func (*ResourceState) GetStatus

func (x *ResourceState) GetStatus() ResourceStatus

func (*ResourceState) GetSystemMetadata added in v0.2.0

func (x *ResourceState) GetSystemMetadata() *SystemMetadataState

func (*ResourceState) GetTemplateName

func (x *ResourceState) GetTemplateName() string

func (*ResourceState) GetType

func (x *ResourceState) GetType() string

func (*ResourceState) ProtoMessage

func (*ResourceState) ProtoMessage()

func (*ResourceState) ProtoReflect

func (x *ResourceState) ProtoReflect() protoreflect.Message

func (*ResourceState) Reset

func (x *ResourceState) Reset()

func (*ResourceState) String

func (x *ResourceState) String() string

type ResourceStatus

type ResourceStatus int32

ResourceStatus represents the current status of a resource in a blueprint instance.

const (
	// The status for when we can't determine
	// an accurate status for a resource.
	ResourceStatus_RESOURCE_STATUS_UNKNOWN ResourceStatus = 0
	// The status for when an initial resource deployment
	// is currently in progress.
	ResourceStatus_RESOURCE_STATUS_CREATING ResourceStatus = 1
	// The status for when a resource has been deployed
	// successfully.
	ResourceStatus_RESOURCE_STATUS_CREATED ResourceStatus = 2
	// The status for when the first creation of a resource
	// failed.
	ResourceStatus_RESOURCE_STATUS_CREATE_FAILED ResourceStatus = 3
	// The status for when a resource is in the process
	// of being destroyed.
	ResourceStatus_RESOURCE_STATUS_DESTROYING ResourceStatus = 4
	// The status for when a resource has been destroyed.
	ResourceStatus_RESOURCE_STATUS_DESTROYED ResourceStatus = 5
	// The status for when the destruction of a resource fails.
	ResourceStatus_RESOURCE_STATUS_DESTROY_FAILED ResourceStatus = 6
	// The status for when a resource is being updated.
	ResourceStatus_RESOURCE_STATUS_UPDATING ResourceStatus = 7
	// The status for when a resource has been successfully updated.
	ResourceStatus_RESOURCE_STATUS_UPDATED ResourceStatus = 8
	// The status for when a resource has failed to update.
	ResourceStatus_RESOURCE_STATUS_UPDATE_FAILED ResourceStatus = 9
	// The status for when another change
	// in the same blueprint has failed and the latest change involving
	// the current resource is being rolled back.
	ResourceStatus_RESOURCE_STATUS_ROLLING_BACK ResourceStatus = 10
	// The status for when another change in the same blueprint
	// has failed and the latest change involving the current resource
	// could not be rolled back.
	ResourceStatus_RESOURCE_STATUS_ROLLBACK_FAILED ResourceStatus = 11
	// The status for when another change in the same blueprint
	// has failed and the latest change involving the current resource
	// has been rolled back.
	ResourceStatus_RESOURCE_STATUS_ROLLBACK_COMPLETE ResourceStatus = 12
	// The status for when a resource creation was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	ResourceStatus_RESOURCE_STATUS_CREATE_INTERRUPTED ResourceStatus = 13
	// The status for when a resource update was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	ResourceStatus_RESOURCE_STATUS_UPDATE_INTERRUPTED ResourceStatus = 14
	// The status for when a resource destruction was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	ResourceStatus_RESOURCE_STATUS_DESTROY_INTERRUPTED ResourceStatus = 15
)

func (ResourceStatus) Descriptor

func (ResourceStatus) Enum

func (x ResourceStatus) Enum() *ResourceStatus

func (ResourceStatus) EnumDescriptor deprecated

func (ResourceStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use ResourceStatus.Descriptor instead.

func (ResourceStatus) Number

func (ResourceStatus) String

func (x ResourceStatus) String() string

func (ResourceStatus) Type

type ResourceType

type ResourceType struct {
	Type string `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

The type of resource to carry out an action on or retrieve some information about.

func (*ResourceType) Descriptor deprecated

func (*ResourceType) Descriptor() ([]byte, []int)

Deprecated: Use ResourceType.ProtoReflect.Descriptor instead.

func (*ResourceType) GetType

func (x *ResourceType) GetType() string

func (*ResourceType) ProtoMessage

func (*ResourceType) ProtoMessage()

func (*ResourceType) ProtoReflect

func (x *ResourceType) ProtoReflect() protoreflect.Message

func (*ResourceType) Reset

func (x *ResourceType) Reset()

func (*ResourceType) String

func (x *ResourceType) String() string

type ResourceTypeInfo

type ResourceTypeInfo struct {

	// The type of the resource.
	Type *ResourceType `protobuf:"bytes,1,opt,name=type" json:"type,omitempty"`
	// The human-readable label for the resource type.
	Label string `protobuf:"bytes,2,opt,name=label" json:"label,omitempty"`
	// contains filtered or unexported fields
}

ResourceTypeInfo provides information about a resource type that can be used for documentation and tooling.

func (*ResourceTypeInfo) Descriptor deprecated

func (*ResourceTypeInfo) Descriptor() ([]byte, []int)

Deprecated: Use ResourceTypeInfo.ProtoReflect.Descriptor instead.

func (*ResourceTypeInfo) GetLabel

func (x *ResourceTypeInfo) GetLabel() string

func (*ResourceTypeInfo) GetType

func (x *ResourceTypeInfo) GetType() *ResourceType

func (*ResourceTypeInfo) ProtoMessage

func (*ResourceTypeInfo) ProtoMessage()

func (*ResourceTypeInfo) ProtoReflect

func (x *ResourceTypeInfo) ProtoReflect() protoreflect.Message

func (*ResourceTypeInfo) Reset

func (x *ResourceTypeInfo) Reset()

func (*ResourceTypeInfo) String

func (x *ResourceTypeInfo) String() string

type ResourceTypeResponse

type ResourceTypeResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*ResourceTypeResponse_ResourceTypeInfo
	//	*ResourceTypeResponse_ErrorResponse
	Response isResourceTypeResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

ResourceTypeResponse is the response containing the type information for a concrete or abstract resource type.

func (*ResourceTypeResponse) Descriptor deprecated

func (*ResourceTypeResponse) Descriptor() ([]byte, []int)

Deprecated: Use ResourceTypeResponse.ProtoReflect.Descriptor instead.

func (*ResourceTypeResponse) GetErrorResponse

func (x *ResourceTypeResponse) GetErrorResponse() *ErrorResponse

func (*ResourceTypeResponse) GetResourceTypeInfo

func (x *ResourceTypeResponse) GetResourceTypeInfo() *ResourceTypeInfo

func (*ResourceTypeResponse) GetResponse

func (x *ResourceTypeResponse) GetResponse() isResourceTypeResponse_Response

func (*ResourceTypeResponse) ProtoMessage

func (*ResourceTypeResponse) ProtoMessage()

func (*ResourceTypeResponse) ProtoReflect

func (x *ResourceTypeResponse) ProtoReflect() protoreflect.Message

func (*ResourceTypeResponse) Reset

func (x *ResourceTypeResponse) Reset()

func (*ResourceTypeResponse) String

func (x *ResourceTypeResponse) String() string

type ResourceTypeResponse_ErrorResponse

type ResourceTypeResponse_ErrorResponse struct {
	ErrorResponse *ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type ResourceTypeResponse_ResourceTypeInfo

type ResourceTypeResponse_ResourceTypeInfo struct {
	ResourceTypeInfo *ResourceTypeInfo `protobuf:"bytes,1,opt,name=resource_type_info,json=resourceTypeInfo,oneof"`
}

type ScalarType

type ScalarType int32

ScalarType represents the type of a scalar value that can be used in annotation and configuration definitions. This is translated to a string enum representation in the deploy engine.

const (
	ScalarType_SCALAR_TYPE_STRING  ScalarType = 0
	ScalarType_SCALAR_TYPE_INTEGER ScalarType = 1
	ScalarType_SCALAR_TYPE_FLOAT   ScalarType = 2
	ScalarType_SCALAR_TYPE_BOOLEAN ScalarType = 3
)

func (ScalarType) Descriptor

func (ScalarType) Descriptor() protoreflect.EnumDescriptor

func (ScalarType) Enum

func (x ScalarType) Enum() *ScalarType

func (ScalarType) EnumDescriptor deprecated

func (ScalarType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ScalarType.Descriptor instead.

func (ScalarType) Number

func (x ScalarType) Number() protoreflect.EnumNumber

func (ScalarType) String

func (x ScalarType) String() string

func (ScalarType) Type

type SourceMeta

type SourceMeta struct {
	StartPosition *SourcePosition `protobuf:"bytes,1,opt,name=start_position,json=startPosition" json:"start_position,omitempty"`
	EndPosition   *SourcePosition `protobuf:"bytes,2,opt,name=end_position,json=endPosition" json:"end_position,omitempty"`
	// contains filtered or unexported fields
}

SourceMeta contains information about the location and range of an element in a source blueprint document.

func (*SourceMeta) Descriptor deprecated

func (*SourceMeta) Descriptor() ([]byte, []int)

Deprecated: Use SourceMeta.ProtoReflect.Descriptor instead.

func (*SourceMeta) GetEndPosition

func (x *SourceMeta) GetEndPosition() *SourcePosition

func (*SourceMeta) GetStartPosition

func (x *SourceMeta) GetStartPosition() *SourcePosition

func (*SourceMeta) ProtoMessage

func (*SourceMeta) ProtoMessage()

func (*SourceMeta) ProtoReflect

func (x *SourceMeta) ProtoReflect() protoreflect.Message

func (*SourceMeta) Reset

func (x *SourceMeta) Reset()

func (*SourceMeta) String

func (x *SourceMeta) String() string

type SourcePosition

type SourcePosition struct {
	Line   int64 `protobuf:"varint,1,opt,name=line" json:"line,omitempty"`
	Column int64 `protobuf:"varint,2,opt,name=column" json:"column,omitempty"`
	// contains filtered or unexported fields
}

SourcePosition contains information about the position of an element in a source blueprint document.

func (*SourcePosition) Descriptor deprecated

func (*SourcePosition) Descriptor() ([]byte, []int)

Deprecated: Use SourcePosition.ProtoReflect.Descriptor instead.

func (*SourcePosition) GetColumn

func (x *SourcePosition) GetColumn() int64

func (*SourcePosition) GetLine

func (x *SourcePosition) GetLine() int64

func (*SourcePosition) ProtoMessage

func (*SourcePosition) ProtoMessage()

func (*SourcePosition) ProtoReflect

func (x *SourcePosition) ProtoReflect() protoreflect.Message

func (*SourcePosition) Reset

func (x *SourcePosition) Reset()

func (*SourcePosition) String

func (x *SourcePosition) String() string

type SystemMetadataState added in v0.2.0

type SystemMetadataState struct {

	// Provenance information for the resource.
	Provenance *ProvenanceState `protobuf:"bytes,1,opt,name=provenance" json:"provenance,omitempty"`
	// contains filtered or unexported fields
}

SystemMetadataState holds system-generated metadata for a resource. This is separate from ResourceMetadataState which holds user-defined blueprint metadata.

func (*SystemMetadataState) Descriptor deprecated added in v0.2.0

func (*SystemMetadataState) Descriptor() ([]byte, []int)

Deprecated: Use SystemMetadataState.ProtoReflect.Descriptor instead.

func (*SystemMetadataState) GetProvenance added in v0.2.0

func (x *SystemMetadataState) GetProvenance() *ProvenanceState

func (*SystemMetadataState) ProtoMessage added in v0.2.0

func (*SystemMetadataState) ProtoMessage()

func (*SystemMetadataState) ProtoReflect added in v0.2.0

func (x *SystemMetadataState) ProtoReflect() protoreflect.Message

func (*SystemMetadataState) Reset added in v0.2.0

func (x *SystemMetadataState) Reset()

func (*SystemMetadataState) String added in v0.2.0

func (x *SystemMetadataState) String() string

type TaggingConfig added in v0.2.0

type TaggingConfig struct {

	// The prefix to apply to all Bluelink tag keys.
	// Default is "bluelink:".
	Prefix string `protobuf:"bytes,1,opt,name=prefix" json:"prefix,omitempty"`
	// The version of the deploy engine.
	DeployEngineVersion string `protobuf:"bytes,2,opt,name=deploy_engine_version,json=deployEngineVersion" json:"deploy_engine_version,omitempty"`
	// The identifier for the provider plugin (e.g., "newstack-cloud/aws").
	ProviderPluginId string `protobuf:"bytes,3,opt,name=provider_plugin_id,json=providerPluginId" json:"provider_plugin_id,omitempty"`
	// The version of the provider plugin.
	ProviderPluginVersion string `protobuf:"bytes,4,opt,name=provider_plugin_version,json=providerPluginVersion" json:"provider_plugin_version,omitempty"`
	// Controls whether tagging is enabled.
	Enabled bool `protobuf:"varint,5,opt,name=enabled" json:"enabled,omitempty"`
	// contains filtered or unexported fields
}

TaggingConfig provides configuration for resource tagging behavior.

func (*TaggingConfig) Descriptor deprecated added in v0.2.0

func (*TaggingConfig) Descriptor() ([]byte, []int)

Deprecated: Use TaggingConfig.ProtoReflect.Descriptor instead.

func (*TaggingConfig) GetDeployEngineVersion added in v0.2.0

func (x *TaggingConfig) GetDeployEngineVersion() string

func (*TaggingConfig) GetEnabled added in v0.2.0

func (x *TaggingConfig) GetEnabled() bool

func (*TaggingConfig) GetPrefix added in v0.2.0

func (x *TaggingConfig) GetPrefix() string

func (*TaggingConfig) GetProviderPluginId added in v0.2.0

func (x *TaggingConfig) GetProviderPluginId() string

func (*TaggingConfig) GetProviderPluginVersion added in v0.2.0

func (x *TaggingConfig) GetProviderPluginVersion() string

func (*TaggingConfig) ProtoMessage added in v0.2.0

func (*TaggingConfig) ProtoMessage()

func (*TaggingConfig) ProtoReflect added in v0.2.0

func (x *TaggingConfig) ProtoReflect() protoreflect.Message

func (*TaggingConfig) Reset added in v0.2.0

func (x *TaggingConfig) Reset()

func (*TaggingConfig) String added in v0.2.0

func (x *TaggingConfig) String() string

type TaggingSupport added in v0.2.0

type TaggingSupport int32

TaggingSupport indicates how a resource type supports external tagging.

const (
	// The resource type does not support tags.
	// Provenance will be stored in Bluelink state only.
	TaggingSupport_TAGGING_SUPPORT_NONE TaggingSupport = 0
	// The resource supports arbitrary key-value tags (AWS, Azure).
	TaggingSupport_TAGGING_SUPPORT_FULL TaggingSupport = 1
	// The resource supports labels with restrictions (GCP, K8s).
	TaggingSupport_TAGGING_SUPPORT_LABELS TaggingSupport = 2
)

func (TaggingSupport) Descriptor added in v0.2.0

func (TaggingSupport) Enum added in v0.2.0

func (x TaggingSupport) Enum() *TaggingSupport

func (TaggingSupport) EnumDescriptor deprecated added in v0.2.0

func (TaggingSupport) EnumDescriptor() ([]byte, []int)

Deprecated: Use TaggingSupport.Descriptor instead.

func (TaggingSupport) Number added in v0.2.0

func (TaggingSupport) String added in v0.2.0

func (x TaggingSupport) String() string

func (TaggingSupport) Type added in v0.2.0

type TypeDescription

type TypeDescription struct {
	MarkdownDescription  string `protobuf:"bytes,1,opt,name=markdown_description,json=markdownDescription" json:"markdown_description,omitempty"`
	PlainTextDescription string `protobuf:"bytes,2,opt,name=plain_text_description,json=plainTextDescription" json:"plain_text_description,omitempty"`
	MarkdownSummary      string `protobuf:"bytes,3,opt,name=markdown_summary,json=markdownSummary" json:"markdown_summary,omitempty"`
	PlainTextSummary     string `protobuf:"bytes,4,opt,name=plain_text_summary,json=plainTextSummary" json:"plain_text_summary,omitempty"`
	// contains filtered or unexported fields
}

TypeDescription provides a description for resource, data source and custom variable types that can be used for documentation and tooling.

func (*TypeDescription) Descriptor deprecated

func (*TypeDescription) Descriptor() ([]byte, []int)

Deprecated: Use TypeDescription.ProtoReflect.Descriptor instead.

func (*TypeDescription) GetMarkdownDescription

func (x *TypeDescription) GetMarkdownDescription() string

func (*TypeDescription) GetMarkdownSummary

func (x *TypeDescription) GetMarkdownSummary() string

func (*TypeDescription) GetPlainTextDescription

func (x *TypeDescription) GetPlainTextDescription() string

func (*TypeDescription) GetPlainTextSummary

func (x *TypeDescription) GetPlainTextSummary() string

func (*TypeDescription) ProtoMessage

func (*TypeDescription) ProtoMessage()

func (*TypeDescription) ProtoReflect

func (x *TypeDescription) ProtoReflect() protoreflect.Message

func (*TypeDescription) Reset

func (x *TypeDescription) Reset()

func (*TypeDescription) String

func (x *TypeDescription) String() string

type TypeDescriptionResponse

type TypeDescriptionResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*TypeDescriptionResponse_Description
	//	*TypeDescriptionResponse_ErrorResponse
	Response isTypeDescriptionResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

ResourceTypeDescriptionResponse is the response containing the description for a plugin entity (e.g. resource).

func (*TypeDescriptionResponse) Descriptor deprecated

func (*TypeDescriptionResponse) Descriptor() ([]byte, []int)

Deprecated: Use TypeDescriptionResponse.ProtoReflect.Descriptor instead.

func (*TypeDescriptionResponse) GetDescription

func (x *TypeDescriptionResponse) GetDescription() *TypeDescription

func (*TypeDescriptionResponse) GetErrorResponse

func (x *TypeDescriptionResponse) GetErrorResponse() *ErrorResponse

func (*TypeDescriptionResponse) GetResponse

func (x *TypeDescriptionResponse) GetResponse() isTypeDescriptionResponse_Response

func (*TypeDescriptionResponse) ProtoMessage

func (*TypeDescriptionResponse) ProtoMessage()

func (*TypeDescriptionResponse) ProtoReflect

func (x *TypeDescriptionResponse) ProtoReflect() protoreflect.Message

func (*TypeDescriptionResponse) Reset

func (x *TypeDescriptionResponse) Reset()

func (*TypeDescriptionResponse) String

func (x *TypeDescriptionResponse) String() string

type TypeDescriptionResponse_Description

type TypeDescriptionResponse_Description struct {
	Description *TypeDescription `protobuf:"bytes,1,opt,name=description,oneof"`
}

type TypeDescriptionResponse_ErrorResponse

type TypeDescriptionResponse_ErrorResponse struct {
	ErrorResponse *ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL