protos

package
v0.0.0-...-bf50695 Latest Latest
Warning

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

Go to latest
Published: Dec 30, 2024 License: BSD-3-Clause Imports: 8 Imported by: 0

README

Run "go generate" in the module top-level directory to update. You need a protoc binary (see https://github.com/golang/protobuf#installation).

Documentation

Index

Constants

View Source
const (
	ReleaseService_UpdateSigningStatus_FullMethodName = "/protos.ReleaseService/UpdateSigningStatus"
)

Variables

View Source
var (
	SignArtifactRequest_BuildType_name = map[int32]string{
		0: "BUILD_TYPE_UNSPECIFIED",
		1: "BUILD_TYPE_MACOS",
		2: "BUILD_TYPE_WINDOWS",
		3: "BUILD_TYPE_GPG",
		4: "BUILD_TYPE_MACOS_CONSTRUCT_INSTALLER_ONLY",
		5: "BUILD_TYPE_WINDOWS_CONSTRUCT_INSTALLER_ONLY",
		6: "BUILD_TYPE_MACOS_BINARY",
		7: "BUILD_TYPE_WINDOWS_BINARY",
	}
	SignArtifactRequest_BuildType_value = map[string]int32{
		"BUILD_TYPE_UNSPECIFIED":                      0,
		"BUILD_TYPE_MACOS":                            1,
		"BUILD_TYPE_WINDOWS":                          2,
		"BUILD_TYPE_GPG":                              3,
		"BUILD_TYPE_MACOS_CONSTRUCT_INSTALLER_ONLY":   4,
		"BUILD_TYPE_WINDOWS_CONSTRUCT_INSTALLER_ONLY": 5,
		"BUILD_TYPE_MACOS_BINARY":                     6,
		"BUILD_TYPE_WINDOWS_BINARY":                   7,
	}
)

Enum value maps for SignArtifactRequest_BuildType.

View Source
var File_internal_relui_protos_relui_proto protoreflect.FileDescriptor
View Source
var ReleaseService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "protos.ReleaseService",
	HandlerType: (*ReleaseServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "UpdateSigningStatus",
			Handler:       _ReleaseService_UpdateSigningStatus_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "internal/relui/protos/relui.proto",
}

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

Functions

func RegisterReleaseServiceServer

func RegisterReleaseServiceServer(s grpc.ServiceRegistrar, srv ReleaseServiceServer)

Types

type ReleaseServiceClient

type ReleaseServiceClient interface {
	// UpdateSigningStatus is a bidirectional connection where server is requesting that the client:
	// - Sign a release artifact.
	// - Provide an update on a previous request to sign a release artifact.
	// - Consider a previous request to sign a release artifact as obsolete.
	// The client initiates a connection with the server and waits for the server to issue a request
	// such as:
	// - An update on the status of a signing request (either running or completed).
	// - An acknowledgement that a request to sign a release artifact has been accepted and initiated.
	UpdateSigningStatus(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[SigningStatus, SigningRequest], error)
}

ReleaseServiceClient is the client API for ReleaseService 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.

ReleaseService enables the signing of release artifacts.

type ReleaseServiceServer

type ReleaseServiceServer interface {
	// UpdateSigningStatus is a bidirectional connection where server is requesting that the client:
	// - Sign a release artifact.
	// - Provide an update on a previous request to sign a release artifact.
	// - Consider a previous request to sign a release artifact as obsolete.
	// The client initiates a connection with the server and waits for the server to issue a request
	// such as:
	// - An update on the status of a signing request (either running or completed).
	// - An acknowledgement that a request to sign a release artifact has been accepted and initiated.
	UpdateSigningStatus(grpc.BidiStreamingServer[SigningStatus, SigningRequest]) error
	// contains filtered or unexported methods
}

ReleaseServiceServer is the server API for ReleaseService service. All implementations must embed UnimplementedReleaseServiceServer for forward compatibility.

ReleaseService enables the signing of release artifacts.

type ReleaseService_UpdateSigningStatusClient

type ReleaseService_UpdateSigningStatusClient = grpc.BidiStreamingClient[SigningStatus, SigningRequest]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type ReleaseService_UpdateSigningStatusServer

type ReleaseService_UpdateSigningStatusServer = grpc.BidiStreamingServer[SigningStatus, SigningRequest]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type SignArtifactCancelRequest

type SignArtifactCancelRequest struct {

	// unique identifier for the signing job.
	JobId string `protobuf:"bytes,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// contains filtered or unexported fields
}

Request to stop a previous signing request sooner if possible.

func (*SignArtifactCancelRequest) Descriptor deprecated

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

Deprecated: Use SignArtifactCancelRequest.ProtoReflect.Descriptor instead.

func (*SignArtifactCancelRequest) GetJobId

func (x *SignArtifactCancelRequest) GetJobId() string

func (*SignArtifactCancelRequest) ProtoMessage

func (*SignArtifactCancelRequest) ProtoMessage()

func (*SignArtifactCancelRequest) ProtoReflect

func (*SignArtifactCancelRequest) Reset

func (x *SignArtifactCancelRequest) Reset()

func (*SignArtifactCancelRequest) String

func (x *SignArtifactCancelRequest) String() string

type SignArtifactRequest

type SignArtifactRequest struct {
	BuildType SignArtifactRequest_BuildType `` /* 131-byte string literal not displayed */
	// The GCS URI for the artifact that should be signed.
	// This artifact must reside in the agreed upon private
	// GCS bucket.
	//
	// There must be at least one entry, and
	// each one points to an individual file.
	// For example, "gs://golang-release-staging/relui-scratch/<...>/go123.linux-amd64.tar.gz".
	GcsUri []string `protobuf:"bytes,2,rep,name=gcs_uri,json=gcsUri,proto3" json:"gcs_uri,omitempty"`
	// contains filtered or unexported fields
}

Request to sign a release artifact.

func (*SignArtifactRequest) Descriptor deprecated

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

Deprecated: Use SignArtifactRequest.ProtoReflect.Descriptor instead.

func (*SignArtifactRequest) GetBuildType

func (*SignArtifactRequest) GetGcsUri

func (x *SignArtifactRequest) GetGcsUri() []string

func (*SignArtifactRequest) ProtoMessage

func (*SignArtifactRequest) ProtoMessage()

func (*SignArtifactRequest) ProtoReflect

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

func (*SignArtifactRequest) Reset

func (x *SignArtifactRequest) Reset()

func (*SignArtifactRequest) String

func (x *SignArtifactRequest) String() string

type SignArtifactRequest_BuildType

type SignArtifactRequest_BuildType int32

The type of artifact signing request.

const (
	SignArtifactRequest_BUILD_TYPE_UNSPECIFIED                      SignArtifactRequest_BuildType = 0
	SignArtifactRequest_BUILD_TYPE_MACOS                            SignArtifactRequest_BuildType = 1
	SignArtifactRequest_BUILD_TYPE_WINDOWS                          SignArtifactRequest_BuildType = 2
	SignArtifactRequest_BUILD_TYPE_GPG                              SignArtifactRequest_BuildType = 3
	SignArtifactRequest_BUILD_TYPE_MACOS_CONSTRUCT_INSTALLER_ONLY   SignArtifactRequest_BuildType = 4
	SignArtifactRequest_BUILD_TYPE_WINDOWS_CONSTRUCT_INSTALLER_ONLY SignArtifactRequest_BuildType = 5
	// Sign individual binary application artifacts.
	// The signing server expects zipped application bundles and signs the files in them.
	SignArtifactRequest_BUILD_TYPE_MACOS_BINARY   SignArtifactRequest_BuildType = 6
	SignArtifactRequest_BUILD_TYPE_WINDOWS_BINARY SignArtifactRequest_BuildType = 7
)

func (SignArtifactRequest_BuildType) Descriptor

func (SignArtifactRequest_BuildType) Enum

func (SignArtifactRequest_BuildType) EnumDescriptor deprecated

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

Deprecated: Use SignArtifactRequest_BuildType.Descriptor instead.

func (SignArtifactRequest_BuildType) Number

func (SignArtifactRequest_BuildType) String

func (SignArtifactRequest_BuildType) Type

type SignArtifactStatusRequest

type SignArtifactStatusRequest struct {

	// unique identifier for the signing job.
	JobId string `protobuf:"bytes,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// contains filtered or unexported fields
}

Request for an update on an existing signing request.

func (*SignArtifactStatusRequest) Descriptor deprecated

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

Deprecated: Use SignArtifactStatusRequest.ProtoReflect.Descriptor instead.

func (*SignArtifactStatusRequest) GetJobId

func (x *SignArtifactStatusRequest) GetJobId() string

func (*SignArtifactStatusRequest) ProtoMessage

func (*SignArtifactStatusRequest) ProtoMessage()

func (*SignArtifactStatusRequest) ProtoReflect

func (*SignArtifactStatusRequest) Reset

func (x *SignArtifactStatusRequest) Reset()

func (*SignArtifactStatusRequest) String

func (x *SignArtifactStatusRequest) String() string

type SigningRequest

type SigningRequest struct {

	// unique identifier for the request. This would normally reside within
	// the metadata. This is primarily used to route requests between
	// caller/responder. The server and client must use the same id for each
	// corresponging request.
	MessageId string `protobuf:"bytes,1,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
	// Request type for the signing client.
	//
	// Types that are assignable to RequestOneof:
	//
	//	*SigningRequest_Sign
	//	*SigningRequest_Status
	//	*SigningRequest_Cancel
	RequestOneof isSigningRequest_RequestOneof `protobuf_oneof:"request_oneof"`
	// contains filtered or unexported fields
}

Request an action from the signing client.

func (*SigningRequest) Descriptor deprecated

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

Deprecated: Use SigningRequest.ProtoReflect.Descriptor instead.

func (*SigningRequest) GetCancel

func (x *SigningRequest) GetCancel() *SignArtifactCancelRequest

func (*SigningRequest) GetMessageId

func (x *SigningRequest) GetMessageId() string

func (*SigningRequest) GetRequestOneof

func (m *SigningRequest) GetRequestOneof() isSigningRequest_RequestOneof

func (*SigningRequest) GetSign

func (x *SigningRequest) GetSign() *SignArtifactRequest

func (*SigningRequest) GetStatus

func (x *SigningRequest) GetStatus() *SignArtifactStatusRequest

func (*SigningRequest) ProtoMessage

func (*SigningRequest) ProtoMessage()

func (*SigningRequest) ProtoReflect

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

func (*SigningRequest) Reset

func (x *SigningRequest) Reset()

func (*SigningRequest) String

func (x *SigningRequest) String() string

type SigningRequest_Cancel

type SigningRequest_Cancel struct {
	Cancel *SignArtifactCancelRequest `protobuf:"bytes,4,opt,name=cancel,proto3,oneof"`
}

type SigningRequest_Sign

type SigningRequest_Sign struct {
	Sign *SignArtifactRequest `protobuf:"bytes,2,opt,name=sign,proto3,oneof"`
}

type SigningRequest_Status

type SigningRequest_Status struct {
	Status *SignArtifactStatusRequest `protobuf:"bytes,3,opt,name=status,proto3,oneof"`
}

type SigningStatus

type SigningStatus struct {

	// unique identifier for the request. This would normally reside within
	// the metadata. This is primarily used to route requests between
	// caller/responder. The server and client must use the same id for each
	// corresponging request.
	MessageId string `protobuf:"bytes,1,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
	// The status type of the signing request.
	//
	// Types that are assignable to StatusOneof:
	//
	//	*SigningStatus_NotFound
	//	*SigningStatus_Started
	//	*SigningStatus_Running
	//	*SigningStatus_Failed
	//	*SigningStatus_Completed
	StatusOneof isSigningStatus_StatusOneof `protobuf_oneof:"status_oneof"`
	// contains filtered or unexported fields
}

The status of the signing request.

func (*SigningStatus) Descriptor deprecated

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

Deprecated: Use SigningStatus.ProtoReflect.Descriptor instead.

func (*SigningStatus) GetCompleted

func (x *SigningStatus) GetCompleted() *StatusCompleted

func (*SigningStatus) GetFailed

func (x *SigningStatus) GetFailed() *StatusFailed

func (*SigningStatus) GetMessageId

func (x *SigningStatus) GetMessageId() string

func (*SigningStatus) GetNotFound

func (x *SigningStatus) GetNotFound() *StatusNotFound

func (*SigningStatus) GetRunning

func (x *SigningStatus) GetRunning() *StatusRunning

func (*SigningStatus) GetStarted

func (x *SigningStatus) GetStarted() *StatusStarted

func (*SigningStatus) GetStatusOneof

func (m *SigningStatus) GetStatusOneof() isSigningStatus_StatusOneof

func (*SigningStatus) ProtoMessage

func (*SigningStatus) ProtoMessage()

func (*SigningStatus) ProtoReflect

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

func (*SigningStatus) Reset

func (x *SigningStatus) Reset()

func (*SigningStatus) String

func (x *SigningStatus) String() string

type SigningStatus_Completed

type SigningStatus_Completed struct {
	Completed *StatusCompleted `protobuf:"bytes,7,opt,name=completed,proto3,oneof"`
}

type SigningStatus_Failed

type SigningStatus_Failed struct {
	Failed *StatusFailed `protobuf:"bytes,6,opt,name=failed,proto3,oneof"`
}

type SigningStatus_NotFound

type SigningStatus_NotFound struct {
	NotFound *StatusNotFound `protobuf:"bytes,3,opt,name=not_found,json=notFound,proto3,oneof"`
}

type SigningStatus_Running

type SigningStatus_Running struct {
	Running *StatusRunning `protobuf:"bytes,5,opt,name=running,proto3,oneof"`
}

type SigningStatus_Started

type SigningStatus_Started struct {
	Started *StatusStarted `protobuf:"bytes,4,opt,name=started,proto3,oneof"`
}

type StatusCompleted

type StatusCompleted struct {

	// The GCS URIs of the signed artifact(s),
	// each one pointing to an individual file.
	// For example, "gs://golang-release-staging/relui-scratch/<...>/go123.linux-amd64.tar.gz".
	GcsUri []string `protobuf:"bytes,1,rep,name=gcs_uri,json=gcsUri,proto3" json:"gcs_uri,omitempty"`
	// contains filtered or unexported fields
}

The signing status for a successfully completed signing request.

func (*StatusCompleted) Descriptor deprecated

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

Deprecated: Use StatusCompleted.ProtoReflect.Descriptor instead.

func (*StatusCompleted) GetGcsUri

func (x *StatusCompleted) GetGcsUri() []string

func (*StatusCompleted) ProtoMessage

func (*StatusCompleted) ProtoMessage()

func (*StatusCompleted) ProtoReflect

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

func (*StatusCompleted) Reset

func (x *StatusCompleted) Reset()

func (*StatusCompleted) String

func (x *StatusCompleted) String() string

type StatusFailed

type StatusFailed struct {

	// Details about the signing request status.
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

The signing status for a failed signing request.

func (*StatusFailed) Descriptor deprecated

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

Deprecated: Use StatusFailed.ProtoReflect.Descriptor instead.

func (*StatusFailed) GetDescription

func (x *StatusFailed) GetDescription() string

func (*StatusFailed) ProtoMessage

func (*StatusFailed) ProtoMessage()

func (*StatusFailed) ProtoReflect

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

func (*StatusFailed) Reset

func (x *StatusFailed) Reset()

func (*StatusFailed) String

func (x *StatusFailed) String() string

type StatusNotFound

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

The signing status for a signing request which does not exist.

func (*StatusNotFound) Descriptor deprecated

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

Deprecated: Use StatusNotFound.ProtoReflect.Descriptor instead.

func (*StatusNotFound) ProtoMessage

func (*StatusNotFound) ProtoMessage()

func (*StatusNotFound) ProtoReflect

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

func (*StatusNotFound) Reset

func (x *StatusNotFound) Reset()

func (*StatusNotFound) String

func (x *StatusNotFound) String() string

type StatusRunning

type StatusRunning struct {

	// Details about the signing request status.
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*StatusRunning) Descriptor deprecated

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

Deprecated: Use StatusRunning.ProtoReflect.Descriptor instead.

func (*StatusRunning) GetDescription

func (x *StatusRunning) GetDescription() string

func (*StatusRunning) ProtoMessage

func (*StatusRunning) ProtoMessage()

func (*StatusRunning) ProtoReflect

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

func (*StatusRunning) Reset

func (x *StatusRunning) Reset()

func (*StatusRunning) String

func (x *StatusRunning) String() string

type StatusStarted

type StatusStarted struct {

	// unique identifier for the signing job that started.
	JobId string `protobuf:"bytes,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// contains filtered or unexported fields
}

The signing status for an in progress signing request.

func (*StatusStarted) Descriptor deprecated

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

Deprecated: Use StatusStarted.ProtoReflect.Descriptor instead.

func (*StatusStarted) GetJobId

func (x *StatusStarted) GetJobId() string

func (*StatusStarted) ProtoMessage

func (*StatusStarted) ProtoMessage()

func (*StatusStarted) ProtoReflect

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

func (*StatusStarted) Reset

func (x *StatusStarted) Reset()

func (*StatusStarted) String

func (x *StatusStarted) String() string

type UnimplementedReleaseServiceServer

type UnimplementedReleaseServiceServer struct{}

UnimplementedReleaseServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedReleaseServiceServer) UpdateSigningStatus

type UnsafeReleaseServiceServer

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

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

Jump to

Keyboard shortcuts

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