planpreview

package
v0.55.0 Latest Latest
Warning

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

 Go to latest Published: Oct 8, 2025 License: Apache-2.0 Imports: 21 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_pkg_plugin_api_v1alpha1_planpreview_api_proto protoreflect.FileDescriptor
View Source 
var PlanPreviewService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "grpc.plugin.planpreviewapi.v1alpha1.PlanPreviewService",
	HandlerType: (*PlanPreviewServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetPlanPreview",
			Handler:    _PlanPreviewService_GetPlanPreview_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "pkg/plugin/api/v1alpha1/planpreview/api.proto",
}

PlanPreviewService_ServiceDesc is the grpc.ServiceDesc for PlanPreviewService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterPlanPreviewServiceServer 

func RegisterPlanPreviewServiceServer(s grpc.ServiceRegistrar, srv PlanPreviewServiceServer)

Types

type GetPlanPreviewRequest 

type GetPlanPreviewRequest struct {

	// ID of the application
	ApplicationId string `protobuf:"bytes,1,opt,name=application_id,json=applicationId,proto3" json:"application_id,omitempty"`
	// Names of the deploy targets.
	DeployTargets []string `protobuf:"bytes,2,rep,name=deploy_targets,json=deployTargets,proto3" json:"deploy_targets,omitempty"`
	// Target deployment source.
	TargetDeploymentSource *common.DeploymentSource `` /* 129-byte string literal not displayed */
	// Running deployment source.
	RunningDeploymentSource *common.DeploymentSource `` /* 132-byte string literal not displayed */
	// Name of the application
	ApplicationName string `protobuf:"bytes,5,opt,name=application_name,json=applicationName,proto3" json:"application_name,omitempty"`
	// ID of the piped
	PipedId string `protobuf:"bytes,6,opt,name=piped_id,json=pipedId,proto3" json:"piped_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPlanPreviewRequest) Descriptor deprecated 

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

Deprecated: Use GetPlanPreviewRequest.ProtoReflect.Descriptor instead.

func (*GetPlanPreviewRequest) GetApplicationId 

func (x *GetPlanPreviewRequest) GetApplicationId() string

func (*GetPlanPreviewRequest) GetApplicationName added in v0.54.0 

func (x *GetPlanPreviewRequest) GetApplicationName() string

func (*GetPlanPreviewRequest) GetDeployTargets 

func (x *GetPlanPreviewRequest) GetDeployTargets() []string

func (*GetPlanPreviewRequest) GetPipedId added in v0.54.0 

func (x *GetPlanPreviewRequest) GetPipedId() string

func (*GetPlanPreviewRequest) GetRunningDeploymentSource added in v0.54.0 

func (x *GetPlanPreviewRequest) GetRunningDeploymentSource() *common.DeploymentSource

func (*GetPlanPreviewRequest) GetTargetDeploymentSource 

func (x *GetPlanPreviewRequest) GetTargetDeploymentSource() *common.DeploymentSource

func (*GetPlanPreviewRequest) ProtoMessage 

func (*GetPlanPreviewRequest) ProtoMessage()

func (*GetPlanPreviewRequest) ProtoReflect 

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

func (*GetPlanPreviewRequest) Reset 

func (x *GetPlanPreviewRequest) Reset()

func (*GetPlanPreviewRequest) String 

func (x *GetPlanPreviewRequest) String() string

func (*GetPlanPreviewRequest) Validate 

func (m *GetPlanPreviewRequest) Validate() error

Validate checks the field values on GetPlanPreviewRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*GetPlanPreviewRequest) ValidateAll 

func (m *GetPlanPreviewRequest) ValidateAll() error

ValidateAll checks the field values on GetPlanPreviewRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in GetPlanPreviewRequestMultiError, or nil if none found.

type GetPlanPreviewRequestMultiError 

type GetPlanPreviewRequestMultiError []error

GetPlanPreviewRequestMultiError is an error wrapping multiple validation errors returned by GetPlanPreviewRequest.ValidateAll() if the designated constraints aren't met.

func (GetPlanPreviewRequestMultiError) AllErrors 

func (m GetPlanPreviewRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GetPlanPreviewRequestMultiError) Error 

func (m GetPlanPreviewRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type GetPlanPreviewRequestValidationError 

type GetPlanPreviewRequestValidationError struct {
	// contains filtered or unexported fields
}

GetPlanPreviewRequestValidationError is the validation error returned by GetPlanPreviewRequest.Validate if the designated constraints aren't met.

func (GetPlanPreviewRequestValidationError) Cause 

func (e GetPlanPreviewRequestValidationError) Cause() error

Cause function returns cause value.

func (GetPlanPreviewRequestValidationError) Error 

func (e GetPlanPreviewRequestValidationError) Error() string

Error satisfies the builtin error interface

func (GetPlanPreviewRequestValidationError) ErrorName 

func (e GetPlanPreviewRequestValidationError) ErrorName() string

ErrorName returns error name.

func (GetPlanPreviewRequestValidationError) Field 

func (e GetPlanPreviewRequestValidationError) Field() string

Field function returns field value.

func (GetPlanPreviewRequestValidationError) Key 

func (e GetPlanPreviewRequestValidationError) Key() bool

Key function returns key value.

func (GetPlanPreviewRequestValidationError) Reason 

func (e GetPlanPreviewRequestValidationError) Reason() string

Reason function returns reason value.

type GetPlanPreviewResponse 

type GetPlanPreviewResponse struct {

	// Results for each deploy target.
	Results []*PlanPreviewResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPlanPreviewResponse) Descriptor deprecated 

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

Deprecated: Use GetPlanPreviewResponse.ProtoReflect.Descriptor instead.

func (*GetPlanPreviewResponse) GetResults 

func (x *GetPlanPreviewResponse) GetResults() []*PlanPreviewResult

func (*GetPlanPreviewResponse) ProtoMessage 

func (*GetPlanPreviewResponse) ProtoMessage()

func (*GetPlanPreviewResponse) ProtoReflect 

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

func (*GetPlanPreviewResponse) Reset 

func (x *GetPlanPreviewResponse) Reset()

func (*GetPlanPreviewResponse) String 

func (x *GetPlanPreviewResponse) String() string

func (*GetPlanPreviewResponse) Validate 

func (m *GetPlanPreviewResponse) Validate() error

Validate checks the field values on GetPlanPreviewResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*GetPlanPreviewResponse) ValidateAll 

func (m *GetPlanPreviewResponse) ValidateAll() error

ValidateAll checks the field values on GetPlanPreviewResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in GetPlanPreviewResponseMultiError, or nil if none found.

type GetPlanPreviewResponseMultiError 

type GetPlanPreviewResponseMultiError []error

GetPlanPreviewResponseMultiError is an error wrapping multiple validation errors returned by GetPlanPreviewResponse.ValidateAll() if the designated constraints aren't met.

func (GetPlanPreviewResponseMultiError) AllErrors 

func (m GetPlanPreviewResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GetPlanPreviewResponseMultiError) Error 

func (m GetPlanPreviewResponseMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type GetPlanPreviewResponseValidationError 

type GetPlanPreviewResponseValidationError struct {
	// contains filtered or unexported fields
}

GetPlanPreviewResponseValidationError is the validation error returned by GetPlanPreviewResponse.Validate if the designated constraints aren't met.

func (GetPlanPreviewResponseValidationError) Cause 

func (e GetPlanPreviewResponseValidationError) Cause() error

Cause function returns cause value.

func (GetPlanPreviewResponseValidationError) Error 

func (e GetPlanPreviewResponseValidationError) Error() string

Error satisfies the builtin error interface

func (GetPlanPreviewResponseValidationError) ErrorName 

func (e GetPlanPreviewResponseValidationError) ErrorName() string

ErrorName returns error name.

func (GetPlanPreviewResponseValidationError) Field 

func (e GetPlanPreviewResponseValidationError) Field() string

Field function returns field value.

func (GetPlanPreviewResponseValidationError) Key 

func (e GetPlanPreviewResponseValidationError) Key() bool

Key function returns key value.

func (GetPlanPreviewResponseValidationError) Reason 

func (e GetPlanPreviewResponseValidationError) Reason() string

Reason function returns reason value.

type PlanPreviewResult 

type PlanPreviewResult struct {

	// Name of the deploy target.
	DeployTarget string `protobuf:"bytes,1,opt,name=deploy_target,json=deployTarget,proto3" json:"deploy_target,omitempty"`
	// Summary of the result.
	Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	// Whether any change are detected or not.
	NoChange bool `protobuf:"varint,3,opt,name=no_change,json=noChange,proto3" json:"no_change,omitempty"`
	// Content of the result.
	Details []byte `protobuf:"bytes,4,opt,name=details,proto3" json:"details,omitempty"`
	// The language to render the details like "diff","hcl".
	// If this is empty, "diff" will be used by default.
	DiffLanguage string `protobuf:"bytes,5,opt,name=diff_language,json=diffLanguage,proto3" json:"diff_language,omitempty"`
	// contains filtered or unexported fields
}

func (*PlanPreviewResult) Descriptor deprecated 

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

Deprecated: Use PlanPreviewResult.ProtoReflect.Descriptor instead.

func (*PlanPreviewResult) GetDeployTarget 

func (x *PlanPreviewResult) GetDeployTarget() string

func (*PlanPreviewResult) GetDetails 

func (x *PlanPreviewResult) GetDetails() []byte

func (*PlanPreviewResult) GetDiffLanguage 

func (x *PlanPreviewResult) GetDiffLanguage() string

func (*PlanPreviewResult) GetNoChange 

func (x *PlanPreviewResult) GetNoChange() bool

func (*PlanPreviewResult) GetSummary 

func (x *PlanPreviewResult) GetSummary() string

func (*PlanPreviewResult) ProtoMessage 

func (*PlanPreviewResult) ProtoMessage()

func (*PlanPreviewResult) ProtoReflect 

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

func (*PlanPreviewResult) Reset 

func (x *PlanPreviewResult) Reset()

func (*PlanPreviewResult) String 

func (x *PlanPreviewResult) String() string

func (*PlanPreviewResult) Validate 

func (m *PlanPreviewResult) Validate() error

Validate checks the field values on PlanPreviewResult with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*PlanPreviewResult) ValidateAll 

func (m *PlanPreviewResult) ValidateAll() error

ValidateAll checks the field values on PlanPreviewResult with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PlanPreviewResultMultiError, or nil if none found.

type PlanPreviewResultMultiError 

type PlanPreviewResultMultiError []error

PlanPreviewResultMultiError is an error wrapping multiple validation errors returned by PlanPreviewResult.ValidateAll() if the designated constraints aren't met.

func (PlanPreviewResultMultiError) AllErrors 

func (m PlanPreviewResultMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PlanPreviewResultMultiError) Error 

func (m PlanPreviewResultMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PlanPreviewResultValidationError 

type PlanPreviewResultValidationError struct {
	// contains filtered or unexported fields
}

PlanPreviewResultValidationError is the validation error returned by PlanPreviewResult.Validate if the designated constraints aren't met.

func (PlanPreviewResultValidationError) Cause 

func (e PlanPreviewResultValidationError) Cause() error

Cause function returns cause value.

func (PlanPreviewResultValidationError) Error 

func (e PlanPreviewResultValidationError) Error() string

Error satisfies the builtin error interface

func (PlanPreviewResultValidationError) ErrorName 

func (e PlanPreviewResultValidationError) ErrorName() string

ErrorName returns error name.

func (PlanPreviewResultValidationError) Field 

func (e PlanPreviewResultValidationError) Field() string

Field function returns field value.

func (PlanPreviewResultValidationError) Key 

func (e PlanPreviewResultValidationError) Key() bool

Key function returns key value.

func (PlanPreviewResultValidationError) Reason 

func (e PlanPreviewResultValidationError) Reason() string

Reason function returns reason value.

type PlanPreviewServiceClient 

type PlanPreviewServiceClient interface {
	// GetPlanPreview gets the plan preview result for the given application.
	// The plugin will compare the target deployment source with the actual states of the deploy targets.
	GetPlanPreview(ctx context.Context, in *GetPlanPreviewRequest, opts ...grpc.CallOption) (*GetPlanPreviewResponse, error)
}

PlanPreviewServiceClient is the client API for PlanPreviewService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewPlanPreviewServiceClient 

func NewPlanPreviewServiceClient(cc grpc.ClientConnInterface) PlanPreviewServiceClient

type PlanPreviewServiceServer 

type PlanPreviewServiceServer interface {
	// GetPlanPreview gets the plan preview result for the given application.
	// The plugin will compare the target deployment source with the actual states of the deploy targets.
	GetPlanPreview(context.Context, *GetPlanPreviewRequest) (*GetPlanPreviewResponse, error)
	// contains filtered or unexported methods
}

PlanPreviewServiceServer is the server API for PlanPreviewService service. All implementations must embed UnimplementedPlanPreviewServiceServer for forward compatibility

type UnimplementedPlanPreviewServiceServer 

type UnimplementedPlanPreviewServiceServer struct {
}

UnimplementedPlanPreviewServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedPlanPreviewServiceServer) GetPlanPreview 

func (UnimplementedPlanPreviewServiceServer) GetPlanPreview(context.Context, *GetPlanPreviewRequest) (*GetPlanPreviewResponse, error)

type UnsafePlanPreviewServiceServer 

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

UnsafePlanPreviewServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PlanPreviewServiceServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.