Documentation ¶
Overview ¶
Package v1alpha1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterBuildCollectorHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterBuildCollectorHandlerClient(ctx context.Context, mux *runtime.ServeMux, client BuildCollectorClient) error
- func RegisterBuildCollectorHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterBuildCollectorHandlerServer(ctx context.Context, mux *runtime.ServeMux, server BuildCollectorServer) error
- func RegisterBuildCollectorServer(s grpc.ServiceRegistrar, srv BuildCollectorServer)
- type Artifact
- type BuildCollectorClient
- type BuildCollectorServer
- type CreateBuildRequest
- func (*CreateBuildRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateBuildRequest) GetArtifacts() []*Artifact
- func (x *CreateBuildRequest) GetBuildEnd() *timestamp.Timestamp
- func (x *CreateBuildRequest) GetBuildStart() *timestamp.Timestamp
- func (x *CreateBuildRequest) GetCommitId() string
- func (x *CreateBuildRequest) GetCommitUri() string
- func (x *CreateBuildRequest) GetCreator() string
- func (x *CreateBuildRequest) GetLogsUri() string
- func (x *CreateBuildRequest) GetProvenanceId() string
- func (x *CreateBuildRequest) GetRepository() string
- func (*CreateBuildRequest) ProtoMessage()
- func (x *CreateBuildRequest) ProtoReflect() protoreflect.Message
- func (x *CreateBuildRequest) Reset()
- func (x *CreateBuildRequest) String() string
- type CreateBuildResponse
- func (*CreateBuildResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateBuildResponse) GetBuildOccurrenceId() string
- func (*CreateBuildResponse) ProtoMessage()
- func (x *CreateBuildResponse) ProtoReflect() protoreflect.Message
- func (x *CreateBuildResponse) Reset()
- func (x *CreateBuildResponse) String() string
- type UnimplementedBuildCollectorServer
- type UnsafeBuildCollectorServer
- type UpdateBuildArtifactsRequest
- func (*UpdateBuildArtifactsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateBuildArtifactsRequest) GetExistingArtifactId() string
- func (x *UpdateBuildArtifactsRequest) GetNewArtifact() *Artifact
- func (*UpdateBuildArtifactsRequest) ProtoMessage()
- func (x *UpdateBuildArtifactsRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateBuildArtifactsRequest) Reset()
- func (x *UpdateBuildArtifactsRequest) String() string
- type UpdateBuildArtifactsResponse
- func (*UpdateBuildArtifactsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateBuildArtifactsResponse) GetBuildOccurrenceId() string
- func (*UpdateBuildArtifactsResponse) ProtoMessage()
- func (x *UpdateBuildArtifactsResponse) ProtoReflect() protoreflect.Message
- func (x *UpdateBuildArtifactsResponse) Reset()
- func (x *UpdateBuildArtifactsResponse) String() string
Constants ¶
This section is empty.
Variables ¶
var BuildCollector_ServiceDesc = grpc.ServiceDesc{ ServiceName: "build_collector.v1alpha1.BuildCollector", HandlerType: (*BuildCollectorServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CreateBuild", Handler: _BuildCollector_CreateBuild_Handler, }, { MethodName: "UpdateBuildArtifacts", Handler: _BuildCollector_UpdateBuildArtifacts_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "proto/v1alpha1/build_collector.proto", }
BuildCollector_ServiceDesc is the grpc.ServiceDesc for BuildCollector service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_proto_v1alpha1_build_collector_proto protoreflect.FileDescriptor
Functions ¶
func RegisterBuildCollectorHandler ¶
func RegisterBuildCollectorHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterBuildCollectorHandler registers the http handlers for service BuildCollector to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterBuildCollectorHandlerClient ¶
func RegisterBuildCollectorHandlerClient(ctx context.Context, mux *runtime.ServeMux, client BuildCollectorClient) error
RegisterBuildCollectorHandlerClient registers the http handlers for service BuildCollector to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "BuildCollectorClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "BuildCollectorClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "BuildCollectorClient" to call the correct interceptors.
func RegisterBuildCollectorHandlerFromEndpoint ¶
func RegisterBuildCollectorHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterBuildCollectorHandlerFromEndpoint is same as RegisterBuildCollectorHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterBuildCollectorHandlerServer ¶
func RegisterBuildCollectorHandlerServer(ctx context.Context, mux *runtime.ServeMux, server BuildCollectorServer) error
RegisterBuildCollectorHandlerServer registers the http handlers for service BuildCollector to "mux". UnaryRPC :call BuildCollectorServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterBuildCollectorHandlerFromEndpoint instead.
func RegisterBuildCollectorServer ¶
func RegisterBuildCollectorServer(s grpc.ServiceRegistrar, srv BuildCollectorServer)
Types ¶
type Artifact ¶ added in v0.2.0
type Artifact struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Names []string `protobuf:"bytes,2,rep,name=names,proto3" json:"names,omitempty"` // contains filtered or unexported fields }
func (*Artifact) Descriptor
deprecated
added in
v0.2.0
func (*Artifact) ProtoMessage ¶ added in v0.2.0
func (*Artifact) ProtoMessage()
func (*Artifact) ProtoReflect ¶ added in v0.2.0
func (x *Artifact) ProtoReflect() protoreflect.Message
type BuildCollectorClient ¶
type BuildCollectorClient interface { CreateBuild(ctx context.Context, in *CreateBuildRequest, opts ...grpc.CallOption) (*CreateBuildResponse, error) UpdateBuildArtifacts(ctx context.Context, in *UpdateBuildArtifactsRequest, opts ...grpc.CallOption) (*UpdateBuildArtifactsResponse, error) }
BuildCollectorClient is the client API for BuildCollector 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 NewBuildCollectorClient ¶
func NewBuildCollectorClient(cc grpc.ClientConnInterface) BuildCollectorClient
type BuildCollectorServer ¶
type BuildCollectorServer interface { CreateBuild(context.Context, *CreateBuildRequest) (*CreateBuildResponse, error) UpdateBuildArtifacts(context.Context, *UpdateBuildArtifactsRequest) (*UpdateBuildArtifactsResponse, error) }
BuildCollectorServer is the server API for BuildCollector service. All implementations should embed UnimplementedBuildCollectorServer for forward compatibility
type CreateBuildRequest ¶
type CreateBuildRequest struct { // The Git repository holding the source code for the artifact(s) Repository string `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"` // Any generated outputs of the build Artifacts []*Artifact `protobuf:"bytes,2,rep,name=artifacts,proto3" json:"artifacts,omitempty"` // Commit SHA CommitId string `protobuf:"bytes,3,opt,name=commit_id,json=commitId,proto3" json:"commit_id,omitempty"` // source of the build ProvenanceId string `protobuf:"bytes,4,opt,name=provenance_id,json=provenanceId,proto3" json:"provenance_id,omitempty"` // link to the build logs LogsUri string `protobuf:"bytes,5,opt,name=logs_uri,json=logsUri,proto3" json:"logs_uri,omitempty"` // build creator Creator string `protobuf:"bytes,6,opt,name=creator,proto3" json:"creator,omitempty"` // time the build began BuildStart *timestamp.Timestamp `protobuf:"bytes,7,opt,name=build_start,json=buildStart,proto3" json:"build_start,omitempty"` // timestamp of when the build ended BuildEnd *timestamp.Timestamp `protobuf:"bytes,8,opt,name=build_end,json=buildEnd,proto3" json:"build_end,omitempty"` // link to a diff of the changeset CommitUri string `protobuf:"bytes,9,opt,name=commit_uri,json=commitUri,proto3" json:"commit_uri,omitempty"` // contains filtered or unexported fields }
func (*CreateBuildRequest) Descriptor
deprecated
func (*CreateBuildRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateBuildRequest.ProtoReflect.Descriptor instead.
func (*CreateBuildRequest) GetArtifacts ¶
func (x *CreateBuildRequest) GetArtifacts() []*Artifact
func (*CreateBuildRequest) GetBuildEnd ¶ added in v0.2.0
func (x *CreateBuildRequest) GetBuildEnd() *timestamp.Timestamp
func (*CreateBuildRequest) GetBuildStart ¶ added in v0.2.0
func (x *CreateBuildRequest) GetBuildStart() *timestamp.Timestamp
func (*CreateBuildRequest) GetCommitId ¶
func (x *CreateBuildRequest) GetCommitId() string
func (*CreateBuildRequest) GetCommitUri ¶ added in v0.3.0
func (x *CreateBuildRequest) GetCommitUri() string
func (*CreateBuildRequest) GetCreator ¶ added in v0.2.0
func (x *CreateBuildRequest) GetCreator() string
func (*CreateBuildRequest) GetLogsUri ¶ added in v0.2.0
func (x *CreateBuildRequest) GetLogsUri() string
func (*CreateBuildRequest) GetProvenanceId ¶ added in v0.2.0
func (x *CreateBuildRequest) GetProvenanceId() string
func (*CreateBuildRequest) GetRepository ¶
func (x *CreateBuildRequest) GetRepository() string
func (*CreateBuildRequest) ProtoMessage ¶
func (*CreateBuildRequest) ProtoMessage()
func (*CreateBuildRequest) ProtoReflect ¶
func (x *CreateBuildRequest) ProtoReflect() protoreflect.Message
func (*CreateBuildRequest) Reset ¶
func (x *CreateBuildRequest) Reset()
func (*CreateBuildRequest) String ¶
func (x *CreateBuildRequest) String() string
type CreateBuildResponse ¶
type CreateBuildResponse struct { // Unique id of the new build occurrence BuildOccurrenceId string `protobuf:"bytes,1,opt,name=build_occurrence_id,json=buildOccurrenceId,proto3" json:"build_occurrence_id,omitempty"` // contains filtered or unexported fields }
func (*CreateBuildResponse) Descriptor
deprecated
func (*CreateBuildResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateBuildResponse.ProtoReflect.Descriptor instead.
func (*CreateBuildResponse) GetBuildOccurrenceId ¶
func (x *CreateBuildResponse) GetBuildOccurrenceId() string
func (*CreateBuildResponse) ProtoMessage ¶
func (*CreateBuildResponse) ProtoMessage()
func (*CreateBuildResponse) ProtoReflect ¶
func (x *CreateBuildResponse) ProtoReflect() protoreflect.Message
func (*CreateBuildResponse) Reset ¶
func (x *CreateBuildResponse) Reset()
func (*CreateBuildResponse) String ¶
func (x *CreateBuildResponse) String() string
type UnimplementedBuildCollectorServer ¶
type UnimplementedBuildCollectorServer struct { }
UnimplementedBuildCollectorServer should be embedded to have forward compatible implementations.
func (UnimplementedBuildCollectorServer) CreateBuild ¶
func (UnimplementedBuildCollectorServer) CreateBuild(context.Context, *CreateBuildRequest) (*CreateBuildResponse, error)
func (UnimplementedBuildCollectorServer) UpdateBuildArtifacts ¶
func (UnimplementedBuildCollectorServer) UpdateBuildArtifacts(context.Context, *UpdateBuildArtifactsRequest) (*UpdateBuildArtifactsResponse, error)
type UnsafeBuildCollectorServer ¶
type UnsafeBuildCollectorServer interface {
// contains filtered or unexported methods
}
UnsafeBuildCollectorServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to BuildCollectorServer will result in compilation errors.
type UpdateBuildArtifactsRequest ¶
type UpdateBuildArtifactsRequest struct { ExistingArtifactId string `protobuf:"bytes,1,opt,name=existing_artifact_id,json=existingArtifactId,proto3" json:"existing_artifact_id,omitempty"` NewArtifact *Artifact `protobuf:"bytes,2,opt,name=new_artifact,json=newArtifact,proto3" json:"new_artifact,omitempty"` // contains filtered or unexported fields }
func (*UpdateBuildArtifactsRequest) Descriptor
deprecated
func (*UpdateBuildArtifactsRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateBuildArtifactsRequest.ProtoReflect.Descriptor instead.
func (*UpdateBuildArtifactsRequest) GetExistingArtifactId ¶ added in v0.2.0
func (x *UpdateBuildArtifactsRequest) GetExistingArtifactId() string
func (*UpdateBuildArtifactsRequest) GetNewArtifact ¶
func (x *UpdateBuildArtifactsRequest) GetNewArtifact() *Artifact
func (*UpdateBuildArtifactsRequest) ProtoMessage ¶
func (*UpdateBuildArtifactsRequest) ProtoMessage()
func (*UpdateBuildArtifactsRequest) ProtoReflect ¶
func (x *UpdateBuildArtifactsRequest) ProtoReflect() protoreflect.Message
func (*UpdateBuildArtifactsRequest) Reset ¶
func (x *UpdateBuildArtifactsRequest) Reset()
func (*UpdateBuildArtifactsRequest) String ¶
func (x *UpdateBuildArtifactsRequest) String() string
type UpdateBuildArtifactsResponse ¶
type UpdateBuildArtifactsResponse struct { // Unique id of the updated build occurrence BuildOccurrenceId string `protobuf:"bytes,1,opt,name=build_occurrence_id,json=buildOccurrenceId,proto3" json:"build_occurrence_id,omitempty"` // contains filtered or unexported fields }
func (*UpdateBuildArtifactsResponse) Descriptor
deprecated
func (*UpdateBuildArtifactsResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateBuildArtifactsResponse.ProtoReflect.Descriptor instead.
func (*UpdateBuildArtifactsResponse) GetBuildOccurrenceId ¶
func (x *UpdateBuildArtifactsResponse) GetBuildOccurrenceId() string
func (*UpdateBuildArtifactsResponse) ProtoMessage ¶
func (*UpdateBuildArtifactsResponse) ProtoMessage()
func (*UpdateBuildArtifactsResponse) ProtoReflect ¶
func (x *UpdateBuildArtifactsResponse) ProtoReflect() protoreflect.Message
func (*UpdateBuildArtifactsResponse) Reset ¶
func (x *UpdateBuildArtifactsResponse) Reset()
func (*UpdateBuildArtifactsResponse) String ¶
func (x *UpdateBuildArtifactsResponse) String() string