transformerserverv1

type AbstractResourceRequest struct {

	// The type of resource to carry out an action on or retrieve
	// some information about.
	AbstractResourceType *sharedtypesv1.ResourceType `protobuf:"bytes,1,opt,name=abstract_resource_type,json=abstractResourceType" json:"abstract_resource_type,omitempty"`
	// The ID of the host making the request
	// to the transformer.
	HostId string `protobuf:"bytes,2,opt,name=host_id,json=hostId" json:"host_id,omitempty"`
	// Runtime configuration for the current environment
	// specific to the current transformer.
	Context *TransformerContext `protobuf:"bytes,3,opt,name=context" json:"context,omitempty"`
	// contains filtered or unexported fields
}

type AbstractResourceSpecDefinitionResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*AbstractResourceSpecDefinitionResponse_SpecDefinition
	//	*AbstractResourceSpecDefinitionResponse_ErrorResponse
	Response isAbstractResourceSpecDefinitionResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

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

type AbstractResourceSpecDefinitionResponse_SpecDefinition struct {
	SpecDefinition *sharedtypesv1.ResourceSpecDefinition `protobuf:"bytes,1,opt,name=spec_definition,json=specDefinition,oneof"`
}

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

type AbstractResourceTypesResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*AbstractResourceTypesResponse_AbstractResourceTypes
	//	*AbstractResourceTypesResponse_ErrorResponse
	Response isAbstractResourceTypesResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

type AbstractResourceTypesResponse_AbstractResourceTypes struct {
	AbstractResourceTypes *AbstractResourceTypes `protobuf:"bytes,1,opt,name=abstract_resource_types,json=abstractResourceTypes,oneof"`
}

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

type BlueprintTransformRequest struct {

	// The blueprint that should be transformed.
	InputBlueprint *schemapb.Blueprint `protobuf:"bytes,1,opt,name=input_blueprint,json=inputBlueprint" json:"input_blueprint,omitempty"`
	// The ID of the host making the request
	// to the transformer.
	HostId string `protobuf:"bytes,2,opt,name=host_id,json=hostId" json:"host_id,omitempty"`
	// Runtime configuration for the current environment
	// specific to the current transformer.
	Context *TransformerContext `protobuf:"bytes,3,opt,name=context" json:"context,omitempty"`
	// contains filtered or unexported fields
}

type BlueprintTransformResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*BlueprintTransformResponse_TransformedBlueprint
	//	*BlueprintTransformResponse_ErrorResponse
	Response isBlueprintTransformResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

type BlueprintTransformResponse_ErrorResponse struct {
	// An error response if the transformation failed.
	ErrorResponse *sharedtypesv1.ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type BlueprintTransformResponse_TransformedBlueprint struct {
	// The transformed blueprint.
	TransformedBlueprint *schemapb.Blueprint `protobuf:"bytes,1,opt,name=transformed_blueprint,json=transformedBlueprint,oneof"`
}

type CanAbstractResourceLinkToResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*CanAbstractResourceLinkToResponse_ResourceTypes
	//	*CanAbstractResourceLinkToResponse_ErrorResponse
	Response isCanAbstractResourceLinkToResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

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

type CanAbstractResourceLinkToResponse_ResourceTypes struct {
	ResourceTypes *sharedtypesv1.CanLinkTo `protobuf:"bytes,1,opt,name=resource_types,json=resourceTypes,oneof"`
}

type CustomValidateAbstractResourceCompleteResponse struct {
	Diagnostics []*sharedtypesv1.Diagnostic `protobuf:"bytes,1,rep,name=diagnostics" json:"diagnostics,omitempty"`
	// contains filtered or unexported fields
}

type CustomValidateAbstractResourceRequest struct {

	// The type of resource being validate.
	AbstractResourceType *sharedtypesv1.ResourceType `protobuf:"bytes,1,opt,name=abstract_resource_type,json=abstractResourceType" json:"abstract_resource_type,omitempty"`
	// The ID of the host making the request
	// to the transformer.
	HostId string `protobuf:"bytes,2,opt,name=host_id,json=hostId" json:"host_id,omitempty"`
	// The resource schema as parsed within a blueprint.
	SchemaResource *schemapb.Resource `protobuf:"bytes,3,opt,name=schema_resource,json=schemaResource" json:"schema_resource,omitempty"`
	// Runtime configuration for the current environment
	// specific to the current transformer.
	Context *TransformerContext `protobuf:"bytes,4,opt,name=context" json:"context,omitempty"`
	// contains filtered or unexported fields
}

type CustomValidateAbstractResourceResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*CustomValidateAbstractResourceResponse_CompleteResponse
	//	*CustomValidateAbstractResourceResponse_ErrorResponse
	Response isCustomValidateAbstractResourceResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

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

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

type IsAbstractResourceCommonTerminalResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*IsAbstractResourceCommonTerminalResponse_Data
	//	*IsAbstractResourceCommonTerminalResponse_ErrorResponse
	Response isIsAbstractResourceCommonTerminalResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

type IsAbstractResourceCommonTerminalResponse_Data struct {
	Data *sharedtypesv1.ResourceCommonTerminalInfo `protobuf:"bytes,1,opt,name=data,oneof"`
}

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

type TransformNameInfo struct {
	TransformName string `protobuf:"bytes,1,opt,name=transform_name,json=transformName" json:"transform_name,omitempty"`
	// contains filtered or unexported fields
}

type TransformNameResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*TransformNameResponse_NameInfo
	//	*TransformNameResponse_ErrorResponse
	Response isTransformNameResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

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

type TransformNameResponse_NameInfo struct {
	NameInfo *TransformNameInfo `protobuf:"bytes,1,opt,name=name_info,json=nameInfo,oneof"`
}

type TransformerClient interface {
	// GetTransformName returns the transform name of the transformer
	// that should be used in the `transform` section of a blueprint
	// to use this transformer plugin.
	GetTransformName(ctx context.Context, in *TransformerRequest, opts ...grpc.CallOption) (*TransformNameResponse, error)
	// ConfigDefinition retrieves a detailed definition of the configuration
	// that is required for the transformer.
	GetConfigDefinition(ctx context.Context, in *TransformerRequest, opts ...grpc.CallOption) (*sharedtypesv1.ConfigDefinitionResponse, error)
	// Transform a blueprint by expanding abstract resources into their
	// final form along with any other transformations that are required.
	Transform(ctx context.Context, in *BlueprintTransformRequest, opts ...grpc.CallOption) (*BlueprintTransformResponse, error)
	// ListAbstractResourceTypes returns a list of abstract resource types
	// that are supported by the transformer.
	ListAbstractResourceTypes(ctx context.Context, in *TransformerRequest, opts ...grpc.CallOption) (*AbstractResourceTypesResponse, error)
	// CustomValidateAbstractResource deals with carrying out custom validation for
	// an abstract resource that goes beyond the built-in resource spec validation.
	CustomValidateAbstractResource(ctx context.Context, in *CustomValidateAbstractResourceRequest, opts ...grpc.CallOption) (*CustomValidateAbstractResourceResponse, error)
	// GetAbstractResourceSpecDefinition retrieves the spec definition for an abstract resource,
	// this is used as the first line of validation for a resource in a blueprint
	// and is also useful for validating references to a resource instance
	// in a blueprint and for providing definitions for docs and tooling.
	// The spec defines both the schema for the resource spec fields that can be defined
	// by users in a blueprint and computed fields that are derived from the deployed
	// resource in the external provider (e.g. Lambda ARN in AWS).
	GetAbstractResourceSpecDefinition(ctx context.Context, in *AbstractResourceRequest, opts ...grpc.CallOption) (*AbstractResourceSpecDefinitionResponse, error)
	// CanAbstractResourceLinkTo produces a list of all the resource types
	// that the given abstract resource type can link to.
	CanAbstractResourceLinkTo(ctx context.Context, in *AbstractResourceRequest, opts ...grpc.CallOption) (*CanAbstractResourceLinkToResponse, error)
	// IsAbstractResourceCommonTerminal specifies whether the given abstract resource type is expected
	// to have a common use-case as a terminal resource that does not link out to other resources.
	// This is useful for providing warnings to users about their blueprints
	// without overloading them with warnings for all resources that don't have any outbound
	// links that could have.
	IsAbstractResourceCommonTerminal(ctx context.Context, in *AbstractResourceRequest, opts ...grpc.CallOption) (*IsAbstractResourceCommonTerminalResponse, error)
	// GetAbstractResourceType retrieves the type of an abstract resource in a blueprint spec
	// that can be used for documentation and tooling.
	// This allows callers to get a human-readable label for the already known
	// resource type.
	GetAbstractResourceType(ctx context.Context, in *AbstractResourceRequest, opts ...grpc.CallOption) (*sharedtypesv1.ResourceTypeResponse, error)
	// GetAbstractResourceTypeDescription retrieves the description for an abstract resource type
	// in a blueprint spec that can be used for documentation and tooling.
	// Markdown and plain text formats are supported.
	GetAbstractResourceTypeDescription(ctx context.Context, in *AbstractResourceRequest, opts ...grpc.CallOption) (*sharedtypesv1.TypeDescriptionResponse, error)
	// GetAbstractResourceExamples deals with retrieving a list of examples
	// for an abstract resource type in a blueprint spec that can be used
	// for documentation and tooling.
	// Markdown and plain text formats are supported.
	GetAbstractResourceExamples(ctx context.Context, in *AbstractResourceRequest, opts ...grpc.CallOption) (*sharedtypesv1.ExamplesResponse, error)
}

type TransformerContext struct {

	// Configuration parameters specifically for the transformer.
	TransformerConfigVariables map[string]*schemapb.ScalarValue `` /* 208-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 */
	// contains filtered or unexported fields
}

type TransformerRequest struct {

	// The ID of the host making the request
	// to the transformer.
	HostId string `protobuf:"bytes,1,opt,name=host_id,json=hostId" json:"host_id,omitempty"`
	// contains filtered or unexported fields
}

type TransformerServer interface {
	// GetTransformName returns the transform name of the transformer
	// that should be used in the `transform` section of a blueprint
	// to use this transformer plugin.
	GetTransformName(context.Context, *TransformerRequest) (*TransformNameResponse, error)
	// ConfigDefinition retrieves a detailed definition of the configuration
	// that is required for the transformer.
	GetConfigDefinition(context.Context, *TransformerRequest) (*sharedtypesv1.ConfigDefinitionResponse, error)
	// Transform a blueprint by expanding abstract resources into their
	// final form along with any other transformations that are required.
	Transform(context.Context, *BlueprintTransformRequest) (*BlueprintTransformResponse, error)
	// ListAbstractResourceTypes returns a list of abstract resource types
	// that are supported by the transformer.
	ListAbstractResourceTypes(context.Context, *TransformerRequest) (*AbstractResourceTypesResponse, error)
	// CustomValidateAbstractResource deals with carrying out custom validation for
	// an abstract resource that goes beyond the built-in resource spec validation.
	CustomValidateAbstractResource(context.Context, *CustomValidateAbstractResourceRequest) (*CustomValidateAbstractResourceResponse, error)
	// GetAbstractResourceSpecDefinition retrieves the spec definition for an abstract resource,
	// this is used as the first line of validation for a resource in a blueprint
	// and is also useful for validating references to a resource instance
	// in a blueprint and for providing definitions for docs and tooling.
	// The spec defines both the schema for the resource spec fields that can be defined
	// by users in a blueprint and computed fields that are derived from the deployed
	// resource in the external provider (e.g. Lambda ARN in AWS).
	GetAbstractResourceSpecDefinition(context.Context, *AbstractResourceRequest) (*AbstractResourceSpecDefinitionResponse, error)
	// CanAbstractResourceLinkTo produces a list of all the resource types
	// that the given abstract resource type can link to.
	CanAbstractResourceLinkTo(context.Context, *AbstractResourceRequest) (*CanAbstractResourceLinkToResponse, error)
	// IsAbstractResourceCommonTerminal specifies whether the given abstract resource type is expected
	// to have a common use-case as a terminal resource that does not link out to other resources.
	// This is useful for providing warnings to users about their blueprints
	// without overloading them with warnings for all resources that don't have any outbound
	// links that could have.
	IsAbstractResourceCommonTerminal(context.Context, *AbstractResourceRequest) (*IsAbstractResourceCommonTerminalResponse, error)
	// GetAbstractResourceType retrieves the type of an abstract resource in a blueprint spec
	// that can be used for documentation and tooling.
	// This allows callers to get a human-readable label for the already known
	// resource type.
	GetAbstractResourceType(context.Context, *AbstractResourceRequest) (*sharedtypesv1.ResourceTypeResponse, error)
	// GetAbstractResourceTypeDescription retrieves the description for an abstract resource type
	// in a blueprint spec that can be used for documentation and tooling.
	// Markdown and plain text formats are supported.
	GetAbstractResourceTypeDescription(context.Context, *AbstractResourceRequest) (*sharedtypesv1.TypeDescriptionResponse, error)
	// GetAbstractResourceExamples deals with retrieving a list of examples
	// for an abstract resource type in a blueprint spec that can be used
	// for documentation and tooling.
	// Markdown and plain text formats are supported.
	GetAbstractResourceExamples(context.Context, *AbstractResourceRequest) (*sharedtypesv1.ExamplesResponse, error)
	// contains filtered or unexported methods
}

type UnimplementedTransformerServer struct{}

type UnsafeTransformerServer interface {
	// contains filtered or unexported methods
}