logdog

package
v0.0.0-...-1643519 Latest Latest
Warning

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

 Go to latest Published: Jul 16, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package logdog contains Version 1 of the LogDog Coordinator backend service interface.

The package name here must match the protobuf package name, as the generated files will reside in the same directory.

Index

Constants

This section is empty.

Variables

View Source 
var ArchiveDispatchTask_Tag_name = map[int32]string{
	0: "TERMINATED",
	1: "EXPIRED",
}
View Source 
var ArchiveDispatchTask_Tag_value = map[string]int32{
	"TERMINATED": 0,
	"EXPIRED":    1,
}

Functions

func FileDescriptorSet 

func FileDescriptorSet() *descriptor.FileDescriptorSet

FileDescriptorSet returns a descriptor set for this proto package, which includes all defined services, and all transitive dependencies.

Will not return nil.

Do NOT modify the returned descriptor.

func RegisterServicesServer 

func RegisterServicesServer(s prpc.Registrar, srv ServicesServer)

Types

type ArchiveDispatchTask 

type ArchiveDispatchTask struct {
	// The hash ID for the log stream to archive.
	Id  string                  `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Tag ArchiveDispatchTask_Tag `protobuf:"varint,2,opt,name=tag,proto3,enum=logdog.ArchiveDispatchTask_Tag" json:"tag,omitempty"`
	// Don't waste time archiving the log stream until it is at least this old.
	//
	// This is in place to prevent overly-aggressive archivals from wasting time
	// trying, then failing, becuase the log stream data is still being collected
	// into intermediate storage.
	SettleDelay *duration.Duration `protobuf:"bytes,3,opt,name=settle_delay,json=settleDelay,proto3" json:"settle_delay,omitempty"`
	// The amount of time after the task was created that log stream completeness
	// will be used as a success criteria. If the task's age is older than this
	// value, completeness will not be enforced.
	//
	// The task's age can be calculated by subtracting its lease expiration time
	// (leaseTimestamp) from its enqueued timestamp (enqueueTimestamp).
	CompletePeriod       *duration.Duration `protobuf:"bytes,4,opt,name=complete_period,json=completePeriod,proto3" json:"complete_period,omitempty"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

ArchiveDispatchTask is an internal task used by the Coordinator to schedule an archival dispatch.

func (*ArchiveDispatchTask) Descriptor 

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

func (*ArchiveDispatchTask) GetCompletePeriod 

func (m *ArchiveDispatchTask) GetCompletePeriod() *duration.Duration

func (*ArchiveDispatchTask) GetId 

func (m *ArchiveDispatchTask) GetId() string

func (*ArchiveDispatchTask) GetSettleDelay 

func (m *ArchiveDispatchTask) GetSettleDelay() *duration.Duration

func (*ArchiveDispatchTask) GetTag 

func (m *ArchiveDispatchTask) GetTag() ArchiveDispatchTask_Tag

func (*ArchiveDispatchTask) ProtoMessage 

func (*ArchiveDispatchTask) ProtoMessage()

func (*ArchiveDispatchTask) Reset 

func (m *ArchiveDispatchTask) Reset()

func (*ArchiveDispatchTask) String 

func (m *ArchiveDispatchTask) String() string

func (*ArchiveDispatchTask) XXX_DiscardUnknown 

func (m *ArchiveDispatchTask) XXX_DiscardUnknown()

func (*ArchiveDispatchTask) XXX_Marshal 

func (m *ArchiveDispatchTask) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ArchiveDispatchTask) XXX_Merge 

func (m *ArchiveDispatchTask) XXX_Merge(src proto.Message)

func (*ArchiveDispatchTask) XXX_Size 

func (m *ArchiveDispatchTask) XXX_Size() int

func (*ArchiveDispatchTask) XXX_Unmarshal 

func (m *ArchiveDispatchTask) XXX_Unmarshal(b []byte) error

type ArchiveDispatchTask_Tag 

type ArchiveDispatchTask_Tag int32

The type of archival task. 

const (
	ArchiveDispatchTask_TERMINATED ArchiveDispatchTask_Tag = 0
	ArchiveDispatchTask_EXPIRED    ArchiveDispatchTask_Tag = 1
)

func (ArchiveDispatchTask_Tag) EnumDescriptor 

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

func (ArchiveDispatchTask_Tag) String 

func (x ArchiveDispatchTask_Tag) String() string

type ArchiveStreamRequest 

type ArchiveStreamRequest struct {
	// The log stream's project.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The Coordinator ID of the log stream that was archived.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// The number of log entries that were archived.
	LogEntryCount int64 `protobuf:"varint,3,opt,name=log_entry_count,json=logEntryCount,proto3" json:"log_entry_count,omitempty"`
	// The highest log stream index that was archived.
	TerminalIndex int64 `protobuf:"varint,4,opt,name=terminal_index,json=terminalIndex,proto3" json:"terminal_index,omitempty"`
	// If not empty, there was an archival error.
	//
	// This field serves to indicate that an error occured (being non-empty) and
	// to supply an value that will show up in the Coordinator ArchiveStream
	// endpoint logs.
	Error string `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`
	// The archive URL of the log stream's stream data.
	StreamUrl string `protobuf:"bytes,10,opt,name=stream_url,json=streamUrl,proto3" json:"stream_url,omitempty"`
	// The size of the log stream's stream data.
	StreamSize int64 `protobuf:"varint,11,opt,name=stream_size,json=streamSize,proto3" json:"stream_size,omitempty"`
	// The archive URL of the log stream's index data.
	IndexUrl string `protobuf:"bytes,20,opt,name=index_url,json=indexUrl,proto3" json:"index_url,omitempty"`
	// The size of the log stream's index data.
	IndexSize int64 `protobuf:"varint,21,opt,name=index_size,json=indexSize,proto3" json:"index_size,omitempty"`
	// The archive URL of the log stream's binary data.
	DataUrl string `protobuf:"bytes,30,opt,name=data_url,json=dataUrl,proto3" json:"data_url,omitempty"`
	// The size of the log stream's binary data.
	DataSize             int64    `protobuf:"varint,31,opt,name=data_size,json=dataSize,proto3" json:"data_size,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

ArchiveStreamRequest is the set of caller-supplied data for the ArchiveStream service endpoint.

func (*ArchiveStreamRequest) Complete 

func (ar *ArchiveStreamRequest) Complete() bool

Complete returns true if the archive request expresses that the archived log stream was complete.

A log stream is complete if every entry between zero and its terminal index is included.

func (*ArchiveStreamRequest) Descriptor 

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

func (*ArchiveStreamRequest) GetDataSize 

func (m *ArchiveStreamRequest) GetDataSize() int64

func (*ArchiveStreamRequest) GetDataUrl 

func (m *ArchiveStreamRequest) GetDataUrl() string

func (*ArchiveStreamRequest) GetError 

func (m *ArchiveStreamRequest) GetError() string

func (*ArchiveStreamRequest) GetId 

func (m *ArchiveStreamRequest) GetId() string

func (*ArchiveStreamRequest) GetIndexSize 

func (m *ArchiveStreamRequest) GetIndexSize() int64

func (*ArchiveStreamRequest) GetIndexUrl 

func (m *ArchiveStreamRequest) GetIndexUrl() string

func (*ArchiveStreamRequest) GetLogEntryCount 

func (m *ArchiveStreamRequest) GetLogEntryCount() int64

func (*ArchiveStreamRequest) GetMessageProject 

func (ar *ArchiveStreamRequest) GetMessageProject() string

GetMessageProject implements ProjectBoundMessage.

func (*ArchiveStreamRequest) GetProject 

func (m *ArchiveStreamRequest) GetProject() string

func (*ArchiveStreamRequest) GetStreamSize 

func (m *ArchiveStreamRequest) GetStreamSize() int64

func (*ArchiveStreamRequest) GetStreamUrl 

func (m *ArchiveStreamRequest) GetStreamUrl() string

func (*ArchiveStreamRequest) GetTerminalIndex 

func (m *ArchiveStreamRequest) GetTerminalIndex() int64

func (*ArchiveStreamRequest) ProtoMessage 

func (*ArchiveStreamRequest) ProtoMessage()

func (*ArchiveStreamRequest) Reset 

func (m *ArchiveStreamRequest) Reset()

func (*ArchiveStreamRequest) String 

func (m *ArchiveStreamRequest) String() string

func (*ArchiveStreamRequest) XXX_DiscardUnknown 

func (m *ArchiveStreamRequest) XXX_DiscardUnknown()

func (*ArchiveStreamRequest) XXX_Marshal 

func (m *ArchiveStreamRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ArchiveStreamRequest) XXX_Merge 

func (m *ArchiveStreamRequest) XXX_Merge(src proto.Message)

func (*ArchiveStreamRequest) XXX_Size 

func (m *ArchiveStreamRequest) XXX_Size() int

func (*ArchiveStreamRequest) XXX_Unmarshal 

func (m *ArchiveStreamRequest) XXX_Unmarshal(b []byte) error

type ArchiveTask 

type ArchiveTask struct {
	// The name of the project that this stream is bound to.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The hash ID of the log stream to archive.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// The archival key of the log stream. If this key doesn't match the key in
	// the log stream state, the request is superfluous and should be deleted.
	Key []byte `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
	// Don't waste time archiving the log stream until it is at least this old.
	//
	// This is in place to prevent overly-aggressive archivals from wasting time
	// trying, then failing, becuase the log stream data is still being collected
	// into intermediate storage.
	SettleDelay *duration.Duration `protobuf:"bytes,4,opt,name=settle_delay,json=settleDelay,proto3" json:"settle_delay,omitempty"`
	// The amount of time after the task was created that log stream completeness
	// will be used as a success criteria. If the task's age is older than this
	// value, completeness will not be enforced.
	//
	// The task's age can be calculated by subtracting its lease expiration time
	// (leaseTimestamp) from its enqueued timestamp (enqueueTimestamp).
	CompletePeriod *duration.Duration `protobuf:"bytes,5,opt,name=complete_period,json=completePeriod,proto3" json:"complete_period,omitempty"`
	// The time when this archive task was dispatched.
	//
	// This time is optional, and will be based on the Coordinator's clock. If not
	// zero, it can be used by the Archivist to avoid superfluous archival
	// processing by asserting that IF this time is close to the Archivist's local
	// clock by a specific threshold, it will punt the archival task.
	//
	// Because archival is dispatched by Tumble, the actual encoding of archival
	// parameters is oftentimes delayed such that the request is dispatched to
	// Pub/Sub before the datastore has been updated.
	DispatchedAt         *timestamp.Timestamp `protobuf:"bytes,6,opt,name=dispatched_at,json=dispatchedAt,proto3" json:"dispatched_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

ArchiveTask is a task queue task description for the archival of a single log stream.

func (*ArchiveTask) Descriptor 

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

func (*ArchiveTask) GetCompletePeriod 

func (m *ArchiveTask) GetCompletePeriod() *duration.Duration

func (*ArchiveTask) GetDispatchedAt 

func (m *ArchiveTask) GetDispatchedAt() *timestamp.Timestamp

func (*ArchiveTask) GetId 

func (m *ArchiveTask) GetId() string

func (*ArchiveTask) GetKey 

func (m *ArchiveTask) GetKey() []byte

func (*ArchiveTask) GetProject 

func (m *ArchiveTask) GetProject() string

func (*ArchiveTask) GetSettleDelay 

func (m *ArchiveTask) GetSettleDelay() *duration.Duration

func (*ArchiveTask) ProtoMessage 

func (*ArchiveTask) ProtoMessage()

func (*ArchiveTask) Reset 

func (m *ArchiveTask) Reset()

func (*ArchiveTask) String 

func (m *ArchiveTask) String() string

func (*ArchiveTask) XXX_DiscardUnknown 

func (m *ArchiveTask) XXX_DiscardUnknown()

func (*ArchiveTask) XXX_Marshal 

func (m *ArchiveTask) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ArchiveTask) XXX_Merge 

func (m *ArchiveTask) XXX_Merge(src proto.Message)

func (*ArchiveTask) XXX_Size 

func (m *ArchiveTask) XXX_Size() int

func (*ArchiveTask) XXX_Unmarshal 

func (m *ArchiveTask) XXX_Unmarshal(b []byte) error

type BatchRequest 

type BatchRequest struct {
	Req                  []*BatchRequest_Entry `protobuf:"bytes,1,rep,name=req,proto3" json:"req,omitempty"`
	XXX_NoUnkeyedLiteral struct{}              `json:"-"`
	XXX_unrecognized     []byte                `json:"-"`
	XXX_sizecache        int32                 `json:"-"`
}

BatchRequest is a batch of individual requests to make to the Coordinator.

func (*BatchRequest) Descriptor 

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

func (*BatchRequest) GetReq 

func (m *BatchRequest) GetReq() []*BatchRequest_Entry

func (*BatchRequest) ProtoMessage 

func (*BatchRequest) ProtoMessage()

func (*BatchRequest) Reset 

func (m *BatchRequest) Reset()

func (*BatchRequest) String 

func (m *BatchRequest) String() string

func (*BatchRequest) XXX_DiscardUnknown 

func (m *BatchRequest) XXX_DiscardUnknown()

func (*BatchRequest) XXX_Marshal 

func (m *BatchRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BatchRequest) XXX_Merge 

func (m *BatchRequest) XXX_Merge(src proto.Message)

func (*BatchRequest) XXX_Size 

func (m *BatchRequest) XXX_Size() int

func (*BatchRequest) XXX_Unmarshal 

func (m *BatchRequest) XXX_Unmarshal(b []byte) error

type BatchRequest_Entry 

type BatchRequest_Entry struct {
	// Types that are valid to be assigned to Value:
	//	*BatchRequest_Entry_RegisterStream
	//	*BatchRequest_Entry_LoadStream
	//	*BatchRequest_Entry_TerminateStream
	//	*BatchRequest_Entry_ArchiveStream
	Value                isBatchRequest_Entry_Value `protobuf_oneof:"value"`
	XXX_NoUnkeyedLiteral struct{}                   `json:"-"`
	XXX_unrecognized     []byte                     `json:"-"`
	XXX_sizecache        int32                      `json:"-"`
}

The collection of batched requests.

func (*BatchRequest_Entry) Descriptor 

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

func (*BatchRequest_Entry) GetArchiveStream 

func (m *BatchRequest_Entry) GetArchiveStream() *ArchiveStreamRequest

func (*BatchRequest_Entry) GetLoadStream 

func (m *BatchRequest_Entry) GetLoadStream() *LoadStreamRequest

func (*BatchRequest_Entry) GetRegisterStream 

func (m *BatchRequest_Entry) GetRegisterStream() *RegisterStreamRequest

func (*BatchRequest_Entry) GetTerminateStream 

func (m *BatchRequest_Entry) GetTerminateStream() *TerminateStreamRequest

func (*BatchRequest_Entry) GetValue 

func (m *BatchRequest_Entry) GetValue() isBatchRequest_Entry_Value

func (*BatchRequest_Entry) ProtoMessage 

func (*BatchRequest_Entry) ProtoMessage()

func (*BatchRequest_Entry) Reset 

func (m *BatchRequest_Entry) Reset()

func (*BatchRequest_Entry) String 

func (m *BatchRequest_Entry) String() string

func (*BatchRequest_Entry) XXX_DiscardUnknown 

func (m *BatchRequest_Entry) XXX_DiscardUnknown()

func (*BatchRequest_Entry) XXX_Marshal 

func (m *BatchRequest_Entry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BatchRequest_Entry) XXX_Merge 

func (m *BatchRequest_Entry) XXX_Merge(src proto.Message)

func (*BatchRequest_Entry) XXX_OneofFuncs 

func (*BatchRequest_Entry) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

func (*BatchRequest_Entry) XXX_Size 

func (m *BatchRequest_Entry) XXX_Size() int

func (*BatchRequest_Entry) XXX_Unmarshal 

func (m *BatchRequest_Entry) XXX_Unmarshal(b []byte) error

type BatchRequest_Entry_ArchiveStream 

type BatchRequest_Entry_ArchiveStream struct {
	ArchiveStream *ArchiveStreamRequest `protobuf:"bytes,4,opt,name=archive_stream,json=archiveStream,proto3,oneof"`
}

type BatchRequest_Entry_LoadStream 

type BatchRequest_Entry_LoadStream struct {
	LoadStream *LoadStreamRequest `protobuf:"bytes,2,opt,name=load_stream,json=loadStream,proto3,oneof"`
}

type BatchRequest_Entry_RegisterStream 

type BatchRequest_Entry_RegisterStream struct {
	RegisterStream *RegisterStreamRequest `protobuf:"bytes,1,opt,name=register_stream,json=registerStream,proto3,oneof"`
}

type BatchRequest_Entry_TerminateStream 

type BatchRequest_Entry_TerminateStream struct {
	TerminateStream *TerminateStreamRequest `protobuf:"bytes,3,opt,name=terminate_stream,json=terminateStream,proto3,oneof"`
}

type BatchResponse 

type BatchResponse struct {
	Resp                 []*BatchResponse_Entry `protobuf:"bytes,1,rep,name=resp,proto3" json:"resp,omitempty"`
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

BatchResponse is a response to a BatchRequest.

func (*BatchResponse) Descriptor 

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

func (*BatchResponse) GetResp 

func (m *BatchResponse) GetResp() []*BatchResponse_Entry

func (*BatchResponse) ProtoMessage 

func (*BatchResponse) ProtoMessage()

func (*BatchResponse) Reset 

func (m *BatchResponse) Reset()

func (*BatchResponse) String 

func (m *BatchResponse) String() string

func (*BatchResponse) XXX_DiscardUnknown 

func (m *BatchResponse) XXX_DiscardUnknown()

func (*BatchResponse) XXX_Marshal 

func (m *BatchResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BatchResponse) XXX_Merge 

func (m *BatchResponse) XXX_Merge(src proto.Message)

func (*BatchResponse) XXX_Size 

func (m *BatchResponse) XXX_Size() int

func (*BatchResponse) XXX_Unmarshal 

func (m *BatchResponse) XXX_Unmarshal(b []byte) error

type BatchResponse_Entry 

type BatchResponse_Entry struct {
	// The index in the BatchRequest for this entry.
	Index int32 `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"`
	// Types that are valid to be assigned to Value:
	//	*BatchResponse_Entry_Err
	//	*BatchResponse_Entry_RegisterStream
	//	*BatchResponse_Entry_LoadStream
	Value                isBatchResponse_Entry_Value `protobuf_oneof:"value"`
	XXX_NoUnkeyedLiteral struct{}                    `json:"-"`
	XXX_unrecognized     []byte                      `json:"-"`
	XXX_sizecache        int32                       `json:"-"`
}

The collection of batched requests.

Each entry corresponds to the BatchRequest entry with the specified index.

Entry objects may appear out of order with their request indexes. Some responses may also be missing, if the remote end could not provide them due to constraints (e.g., size, time).

func (*BatchResponse_Entry) Descriptor 

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

func (*BatchResponse_Entry) GetErr 

func (m *BatchResponse_Entry) GetErr() *Error

func (*BatchResponse_Entry) GetIndex 

func (m *BatchResponse_Entry) GetIndex() int32

func (*BatchResponse_Entry) GetLoadStream 

func (m *BatchResponse_Entry) GetLoadStream() *LoadStreamResponse

func (*BatchResponse_Entry) GetRegisterStream 

func (m *BatchResponse_Entry) GetRegisterStream() *RegisterStreamResponse

func (*BatchResponse_Entry) GetValue 

func (m *BatchResponse_Entry) GetValue() isBatchResponse_Entry_Value

func (*BatchResponse_Entry) ProtoMessage 

func (*BatchResponse_Entry) ProtoMessage()

func (*BatchResponse_Entry) Reset 

func (m *BatchResponse_Entry) Reset()

func (*BatchResponse_Entry) String 

func (m *BatchResponse_Entry) String() string

func (*BatchResponse_Entry) XXX_DiscardUnknown 

func (m *BatchResponse_Entry) XXX_DiscardUnknown()

func (*BatchResponse_Entry) XXX_Marshal 

func (m *BatchResponse_Entry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BatchResponse_Entry) XXX_Merge 

func (m *BatchResponse_Entry) XXX_Merge(src proto.Message)

func (*BatchResponse_Entry) XXX_OneofFuncs 

func (*BatchResponse_Entry) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

func (*BatchResponse_Entry) XXX_Size 

func (m *BatchResponse_Entry) XXX_Size() int

func (*BatchResponse_Entry) XXX_Unmarshal 

func (m *BatchResponse_Entry) XXX_Unmarshal(b []byte) error

type BatchResponse_Entry_Err 

type BatchResponse_Entry_Err struct {
	Err *Error `protobuf:"bytes,2,opt,name=err,proto3,oneof"`
}

type BatchResponse_Entry_LoadStream 

type BatchResponse_Entry_LoadStream struct {
	LoadStream *LoadStreamResponse `protobuf:"bytes,4,opt,name=load_stream,json=loadStream,proto3,oneof"`
}

type BatchResponse_Entry_RegisterStream 

type BatchResponse_Entry_RegisterStream struct {
	RegisterStream *RegisterStreamResponse `protobuf:"bytes,3,opt,name=register_stream,json=registerStream,proto3,oneof"`
}

type DecoratedServices 

type DecoratedServices struct {
	// Service is the service to decorate.
	Service ServicesServer
	// Prelude is called for each method before forwarding the call to Service.
	// If Prelude returns an error, then the call is skipped and the error is
	// processed via the Postlude (if one is defined), or it is returned directly.
	Prelude func(c context.Context, methodName string, req proto.Message) (context.Context, error)
	// Postlude is called for each method after Service has processed the call, or
	// after the Prelude has returned an error. This takes the the Service's
	// response proto (which may be nil) and/or any error. The decorated
	// service will return the response (possibly mutated) and error that Postlude
	// returns.
	Postlude func(c context.Context, methodName string, rsp proto.Message, err error) error
}

func (*DecoratedServices) ArchiveStream 

func (s *DecoratedServices) ArchiveStream(c context.Context, req *ArchiveStreamRequest) (rsp *empty.Empty, err error)

func (*DecoratedServices) Batch 

func (s *DecoratedServices) Batch(c context.Context, req *BatchRequest) (rsp *BatchResponse, err error)

func (*DecoratedServices) GetConfig 

func (s *DecoratedServices) GetConfig(c context.Context, req *empty.Empty) (rsp *GetConfigResponse, err error)

func (*DecoratedServices) LoadStream 

func (s *DecoratedServices) LoadStream(c context.Context, req *LoadStreamRequest) (rsp *LoadStreamResponse, err error)

func (*DecoratedServices) RegisterStream 

func (s *DecoratedServices) RegisterStream(c context.Context, req *RegisterStreamRequest) (rsp *RegisterStreamResponse, err error)

func (*DecoratedServices) TerminateStream 

func (s *DecoratedServices) TerminateStream(c context.Context, req *TerminateStreamRequest) (rsp *empty.Empty, err error)

type Error 

type Error struct {
	// The gRPC code for this error.
	GrpcCode int32 `protobuf:"varint,1,opt,name=grpc_code,json=grpcCode,proto3" json:"grpc_code,omitempty"`
	// Transient is true if this is a transient error.
	Transient bool `protobuf:"varint,2,opt,name=transient,proto3" json:"transient,omitempty"`
	// An optional associated message.
	Msg                  string   `protobuf:"bytes,3,opt,name=msg,proto3" json:"msg,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Error is a projection of a gRPC error.

NOTE: This and its helper functions may be useful more generally. Maybe transplant this to a more general place such as "//grpc" if it ends up being useful.

func MakeError 

func MakeError(err error) *Error

MakeError returns an Error object for err. If err is a wrapped gRPC error, its code will be extracted and embedded in the returned Error.

The Msg field will not be populated.

func (*Error) Descriptor 

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

func (*Error) GetGrpcCode 

func (m *Error) GetGrpcCode() int32

func (*Error) GetMsg 

func (m *Error) GetMsg() string

func (*Error) GetTransient 

func (m *Error) GetTransient() bool

func (*Error) ProtoMessage 

func (*Error) ProtoMessage()

func (*Error) Reset 

func (m *Error) Reset()

func (*Error) String 

func (m *Error) String() string

func (*Error) ToError 

func (e *Error) ToError() error

ToError converts an Error into a gRPC error. If e is nil, a nil error will be returned.

func (*Error) XXX_DiscardUnknown 

func (m *Error) XXX_DiscardUnknown()

func (*Error) XXX_Marshal 

func (m *Error) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Error) XXX_Merge 

func (m *Error) XXX_Merge(src proto.Message)

func (*Error) XXX_Size 

func (m *Error) XXX_Size() int

func (*Error) XXX_Unmarshal 

func (m *Error) XXX_Unmarshal(b []byte) error

type GetConfigResponse 

type GetConfigResponse struct {
	// The API URL of the base "luci-config" service. If empty, the default
	// service URL will be used.
	ConfigServiceUrl string `protobuf:"bytes,1,opt,name=config_service_url,json=configServiceUrl,proto3" json:"config_service_url,omitempty"`
	// The name of the configuration set to load from.
	ConfigSet string `protobuf:"bytes,2,opt,name=config_set,json=configSet,proto3" json:"config_set,omitempty"`
	// The path of the text-serialized service configuration protobuf.
	ServiceConfigPath string `protobuf:"bytes,3,opt,name=service_config_path,json=serviceConfigPath,proto3" json:"service_config_path,omitempty"`
	// The host name of the configuration service. This is preferred to
	// "config_service_url".
	ConfigServiceHost    string   `protobuf:"bytes,4,opt,name=config_service_host,json=configServiceHost,proto3" json:"config_service_host,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

GetConfigResponse is the response structure for the user "GetConfig" endpoint.

func (*GetConfigResponse) Descriptor 

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

func (*GetConfigResponse) GetConfigServiceHost 

func (m *GetConfigResponse) GetConfigServiceHost() string

func (*GetConfigResponse) GetConfigServiceUrl 

func (m *GetConfigResponse) GetConfigServiceUrl() string

func (*GetConfigResponse) GetConfigSet 

func (m *GetConfigResponse) GetConfigSet() string

func (*GetConfigResponse) GetServiceConfigPath 

func (m *GetConfigResponse) GetServiceConfigPath() string

func (*GetConfigResponse) ProtoMessage 

func (*GetConfigResponse) ProtoMessage()

func (*GetConfigResponse) Reset 

func (m *GetConfigResponse) Reset()

func (*GetConfigResponse) String 

func (m *GetConfigResponse) String() string

func (*GetConfigResponse) XXX_DiscardUnknown 

func (m *GetConfigResponse) XXX_DiscardUnknown()

func (*GetConfigResponse) XXX_Marshal 

func (m *GetConfigResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetConfigResponse) XXX_Merge 

func (m *GetConfigResponse) XXX_Merge(src proto.Message)

func (*GetConfigResponse) XXX_Size 

func (m *GetConfigResponse) XXX_Size() int

func (*GetConfigResponse) XXX_Unmarshal 

func (m *GetConfigResponse) XXX_Unmarshal(b []byte) error

type LoadStreamRequest 

type LoadStreamRequest struct {
	// The log stream's project.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The log stream's path Coordinator ID.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// If true, include the log stream descriptor.
	Desc                 bool     `protobuf:"varint,3,opt,name=desc,proto3" json:"desc,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

LoadStreamRequest loads the current state of a log stream.

func (*LoadStreamRequest) Descriptor 

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

func (*LoadStreamRequest) GetDesc 

func (m *LoadStreamRequest) GetDesc() bool

func (*LoadStreamRequest) GetId 

func (m *LoadStreamRequest) GetId() string

func (*LoadStreamRequest) GetMessageProject 

func (ar *LoadStreamRequest) GetMessageProject() string

GetMessageProject implements ProjectBoundMessage.

func (*LoadStreamRequest) GetProject 

func (m *LoadStreamRequest) GetProject() string

func (*LoadStreamRequest) ProtoMessage 

func (*LoadStreamRequest) ProtoMessage()

func (*LoadStreamRequest) Reset 

func (m *LoadStreamRequest) Reset()

func (*LoadStreamRequest) String 

func (m *LoadStreamRequest) String() string

func (*LoadStreamRequest) XXX_DiscardUnknown 

func (m *LoadStreamRequest) XXX_DiscardUnknown()

func (*LoadStreamRequest) XXX_Marshal 

func (m *LoadStreamRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LoadStreamRequest) XXX_Merge 

func (m *LoadStreamRequest) XXX_Merge(src proto.Message)

func (*LoadStreamRequest) XXX_Size 

func (m *LoadStreamRequest) XXX_Size() int

func (*LoadStreamRequest) XXX_Unmarshal 

func (m *LoadStreamRequest) XXX_Unmarshal(b []byte) error

type LoadStreamResponse 

type LoadStreamResponse struct {
	// The state of the requested log stream.
	State *LogStreamState `protobuf:"bytes,1,opt,name=state,proto3" json:"state,omitempty"`
	// If requested, the serialized log stream descriptor. The protobuf version
	// of this descriptor will match the "proto_version" field in "state".
	Desc []byte `protobuf:"bytes,2,opt,name=desc,proto3" json:"desc,omitempty"`
	// The age of the log stream.
	Age *duration.Duration `protobuf:"bytes,3,opt,name=age,proto3" json:"age,omitempty"`
	// The archival key of the log stream. If this key doesn't match the key in
	// the archival request, the request is superfluous and should be deleted.
	ArchivalKey          []byte   `protobuf:"bytes,4,opt,name=archival_key,json=archivalKey,proto3" json:"archival_key,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The response message for the LoadStream RPC.

func (*LoadStreamResponse) Descriptor 

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

func (*LoadStreamResponse) GetAge 

func (m *LoadStreamResponse) GetAge() *duration.Duration

func (*LoadStreamResponse) GetArchivalKey 

func (m *LoadStreamResponse) GetArchivalKey() []byte

func (*LoadStreamResponse) GetDesc 

func (m *LoadStreamResponse) GetDesc() []byte

func (*LoadStreamResponse) GetState 

func (m *LoadStreamResponse) GetState() *LogStreamState

func (*LoadStreamResponse) ProtoMessage 

func (*LoadStreamResponse) ProtoMessage()

func (*LoadStreamResponse) Reset 

func (m *LoadStreamResponse) Reset()

func (*LoadStreamResponse) String 

func (m *LoadStreamResponse) String() string

func (*LoadStreamResponse) XXX_DiscardUnknown 

func (m *LoadStreamResponse) XXX_DiscardUnknown()

func (*LoadStreamResponse) XXX_Marshal 

func (m *LoadStreamResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LoadStreamResponse) XXX_Merge 

func (m *LoadStreamResponse) XXX_Merge(src proto.Message)

func (*LoadStreamResponse) XXX_Size 

func (m *LoadStreamResponse) XXX_Size() int

func (*LoadStreamResponse) XXX_Unmarshal 

func (m *LoadStreamResponse) XXX_Unmarshal(b []byte) error

type LogStreamState 

type LogStreamState struct {
	// ProtoVersion is the protobuf version for this stream.
	ProtoVersion string `protobuf:"bytes,1,opt,name=proto_version,json=protoVersion,proto3" json:"proto_version,omitempty"`
	// The log stream's secret.
	//
	// Note that the secret is returned! This is okay, since this endpoint is only
	// accessible to trusted services. The secret can be cached by services to
	// validate stream information without needing to ping the Coordinator in
	// between each update.
	Secret []byte `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"`
	// The stream index of the log stream's terminal message. If the value is -1,
	// the log is still streaming.
	TerminalIndex int64 `protobuf:"varint,3,opt,name=terminal_index,json=terminalIndex,proto3" json:"terminal_index,omitempty"`
	// If the log stream has been archived.
	Archived bool `protobuf:"varint,4,opt,name=archived,proto3" json:"archived,omitempty"`
	// If the log stream has been purged.
	Purged               bool     `protobuf:"varint,5,opt,name=purged,proto3" json:"purged,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

LogStreamState is the log stream state value communicated to services.

func (*LogStreamState) Descriptor 

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

func (*LogStreamState) GetArchived 

func (m *LogStreamState) GetArchived() bool

func (*LogStreamState) GetProtoVersion 

func (m *LogStreamState) GetProtoVersion() string

func (*LogStreamState) GetPurged 

func (m *LogStreamState) GetPurged() bool

func (*LogStreamState) GetSecret 

func (m *LogStreamState) GetSecret() []byte

func (*LogStreamState) GetTerminalIndex 

func (m *LogStreamState) GetTerminalIndex() int64

func (*LogStreamState) ProtoMessage 

func (*LogStreamState) ProtoMessage()

func (*LogStreamState) Reset 

func (m *LogStreamState) Reset()

func (*LogStreamState) String 

func (m *LogStreamState) String() string

func (*LogStreamState) XXX_DiscardUnknown 

func (m *LogStreamState) XXX_DiscardUnknown()

func (*LogStreamState) XXX_Marshal 

func (m *LogStreamState) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LogStreamState) XXX_Merge 

func (m *LogStreamState) XXX_Merge(src proto.Message)

func (*LogStreamState) XXX_Size 

func (m *LogStreamState) XXX_Size() int

func (*LogStreamState) XXX_Unmarshal 

func (m *LogStreamState) XXX_Unmarshal(b []byte) error

type RegisterStreamRequest 

type RegisterStreamRequest struct {
	// The log stream's project.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The log stream's secret.
	Secret []byte `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"`
	// The protobuf version string for this stream.
	ProtoVersion string `protobuf:"bytes,3,opt,name=proto_version,json=protoVersion,proto3" json:"proto_version,omitempty"`
	// The serialized LogStreamDescriptor protobuf for this stream.
	Desc []byte `protobuf:"bytes,4,opt,name=desc,proto3" json:"desc,omitempty"`
	// The stream's terminal index. If >= 0, the terminal index will be set
	// in the registration request, avoiding the need for an additional
	// termination RPC.
	TerminalIndex        int64    `protobuf:"varint,5,opt,name=terminal_index,json=terminalIndex,proto3" json:"terminal_index,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

RegisterStreamRequest is the set of caller-supplied data for the RegisterStream Coordinator service endpoint.

func (*RegisterStreamRequest) Descriptor 

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

func (*RegisterStreamRequest) GetDesc 

func (m *RegisterStreamRequest) GetDesc() []byte

func (*RegisterStreamRequest) GetMessageProject 

func (ar *RegisterStreamRequest) GetMessageProject() string

GetMessageProject implements ProjectBoundMessage.

func (*RegisterStreamRequest) GetProject 

func (m *RegisterStreamRequest) GetProject() string

func (*RegisterStreamRequest) GetProtoVersion 

func (m *RegisterStreamRequest) GetProtoVersion() string

func (*RegisterStreamRequest) GetSecret 

func (m *RegisterStreamRequest) GetSecret() []byte

func (*RegisterStreamRequest) GetTerminalIndex 

func (m *RegisterStreamRequest) GetTerminalIndex() int64

func (*RegisterStreamRequest) ProtoMessage 

func (*RegisterStreamRequest) ProtoMessage()

func (*RegisterStreamRequest) Reset 

func (m *RegisterStreamRequest) Reset()

func (*RegisterStreamRequest) String 

func (m *RegisterStreamRequest) String() string

func (*RegisterStreamRequest) XXX_DiscardUnknown 

func (m *RegisterStreamRequest) XXX_DiscardUnknown()

func (*RegisterStreamRequest) XXX_Marshal 

func (m *RegisterStreamRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RegisterStreamRequest) XXX_Merge 

func (m *RegisterStreamRequest) XXX_Merge(src proto.Message)

func (*RegisterStreamRequest) XXX_Size 

func (m *RegisterStreamRequest) XXX_Size() int

func (*RegisterStreamRequest) XXX_Unmarshal 

func (m *RegisterStreamRequest) XXX_Unmarshal(b []byte) error

type RegisterStreamResponse 

type RegisterStreamResponse struct {
	// The Coordinator ID of the log stream.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The state of the requested log stream.
	State *LogStreamState `protobuf:"bytes,2,opt,name=state,proto3" json:"state,omitempty"`
	// Error is the error response.
	Error                *Error   `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The response message for the RegisterStream RPC.

func (*RegisterStreamResponse) Descriptor 

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

func (*RegisterStreamResponse) GetError 

func (m *RegisterStreamResponse) GetError() *Error

func (*RegisterStreamResponse) GetId 

func (m *RegisterStreamResponse) GetId() string

func (*RegisterStreamResponse) GetState 

func (m *RegisterStreamResponse) GetState() *LogStreamState

func (*RegisterStreamResponse) ProtoMessage 

func (*RegisterStreamResponse) ProtoMessage()

func (*RegisterStreamResponse) Reset 

func (m *RegisterStreamResponse) Reset()

func (*RegisterStreamResponse) String 

func (m *RegisterStreamResponse) String() string

func (*RegisterStreamResponse) XXX_DiscardUnknown 

func (m *RegisterStreamResponse) XXX_DiscardUnknown()

func (*RegisterStreamResponse) XXX_Marshal 

func (m *RegisterStreamResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RegisterStreamResponse) XXX_Merge 

func (m *RegisterStreamResponse) XXX_Merge(src proto.Message)

func (*RegisterStreamResponse) XXX_Size 

func (m *RegisterStreamResponse) XXX_Size() int

func (*RegisterStreamResponse) XXX_Unmarshal 

func (m *RegisterStreamResponse) XXX_Unmarshal(b []byte) error

type ServicesClient 

type ServicesClient interface {
	// GetConfig allows a service to retrieve the current service configuration
	// parameters.
	GetConfig(ctx context.Context, in *empty.Empty, opts ...grpc.CallOption) (*GetConfigResponse, error)
	// RegisterStream is an idempotent stream state register operation.
	RegisterStream(ctx context.Context, in *RegisterStreamRequest, opts ...grpc.CallOption) (*RegisterStreamResponse, error)
	// LoadStream loads the current state of a log stream.
	LoadStream(ctx context.Context, in *LoadStreamRequest, opts ...grpc.CallOption) (*LoadStreamResponse, error)
	// TerminateStream is an idempotent operation to update the stream's terminal
	// index.
	TerminateStream(ctx context.Context, in *TerminateStreamRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// ArchiveStream is an idempotent operation to record a log stream's archival
	// parameters. It is used by the Archivist service upon successful stream
	// archival.
	ArchiveStream(ctx context.Context, in *ArchiveStreamRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// Batch is a series of requests submitted in batch. It returns a
	// BatchResponse containing the same number of entries, with each entry index
	// corresponding to its request index.
	Batch(ctx context.Context, in *BatchRequest, opts ...grpc.CallOption) (*BatchResponse, error)
}

ServicesClient is the client API for Services service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewServicesClient 

func NewServicesClient(cc *grpc.ClientConn) ServicesClient

func NewServicesPRPCClient 

func NewServicesPRPCClient(client *prpc.Client) ServicesClient

type ServicesServer 

type ServicesServer interface {
	// GetConfig allows a service to retrieve the current service configuration
	// parameters.
	GetConfig(context.Context, *empty.Empty) (*GetConfigResponse, error)
	// RegisterStream is an idempotent stream state register operation.
	RegisterStream(context.Context, *RegisterStreamRequest) (*RegisterStreamResponse, error)
	// LoadStream loads the current state of a log stream.
	LoadStream(context.Context, *LoadStreamRequest) (*LoadStreamResponse, error)
	// TerminateStream is an idempotent operation to update the stream's terminal
	// index.
	TerminateStream(context.Context, *TerminateStreamRequest) (*empty.Empty, error)
	// ArchiveStream is an idempotent operation to record a log stream's archival
	// parameters. It is used by the Archivist service upon successful stream
	// archival.
	ArchiveStream(context.Context, *ArchiveStreamRequest) (*empty.Empty, error)
	// Batch is a series of requests submitted in batch. It returns a
	// BatchResponse containing the same number of entries, with each entry index
	// corresponding to its request index.
	Batch(context.Context, *BatchRequest) (*BatchResponse, error)
}

ServicesServer is the server API for Services service.

type TerminateStreamRequest 

type TerminateStreamRequest struct {
	// The log stream's project.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The log stream's path Coordinator ID.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// The log stream's secret.
	Secret []byte `protobuf:"bytes,3,opt,name=secret,proto3" json:"secret,omitempty"`
	// The terminal index of the stream.
	TerminalIndex        int64    `protobuf:"varint,4,opt,name=terminal_index,json=terminalIndex,proto3" json:"terminal_index,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

TerminateStreamRequest is the set of caller-supplied data for the TerminateStream service endpoint.

func (*TerminateStreamRequest) Descriptor 

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

func (*TerminateStreamRequest) GetId 

func (m *TerminateStreamRequest) GetId() string

func (*TerminateStreamRequest) GetMessageProject 

func (ar *TerminateStreamRequest) GetMessageProject() string

GetMessageProject implements ProjectBoundMessage.

func (*TerminateStreamRequest) GetProject 

func (m *TerminateStreamRequest) GetProject() string

func (*TerminateStreamRequest) GetSecret 

func (m *TerminateStreamRequest) GetSecret() []byte

func (*TerminateStreamRequest) GetTerminalIndex 

func (m *TerminateStreamRequest) GetTerminalIndex() int64

func (*TerminateStreamRequest) ProtoMessage 

func (*TerminateStreamRequest) ProtoMessage()

func (*TerminateStreamRequest) Reset 

func (m *TerminateStreamRequest) Reset()

func (*TerminateStreamRequest) String 

func (m *TerminateStreamRequest) String() string

func (*TerminateStreamRequest) XXX_DiscardUnknown 

func (m *TerminateStreamRequest) XXX_DiscardUnknown()

func (*TerminateStreamRequest) XXX_Marshal 

func (m *TerminateStreamRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TerminateStreamRequest) XXX_Merge 

func (m *TerminateStreamRequest) XXX_Merge(src proto.Message)

func (*TerminateStreamRequest) XXX_Size 

func (m *TerminateStreamRequest) XXX_Size() int

func (*TerminateStreamRequest) XXX_Unmarshal 

func (m *TerminateStreamRequest) XXX_Unmarshal(b []byte) error

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.