Back to godoc.org

Package logdog

v0.0.0-...-1557bcf
Latest Go to latest

The latest major version is .

Published: Aug 13, 2020 | License: Apache-2.0 | Module: github.com/luci/luci-go

Overview

Package logdog contains Version 1 of the LogDog Coordinator user interface.

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

Index

Variables

var (
	QueryRequest_Trinary_name = map[int32]string{
		0: "BOTH",
		1: "YES",
		2: "NO",
	}
	QueryRequest_Trinary_value = map[string]int32{
		"BOTH": 0,
		"YES":  1,
		"NO":   2,
	}
)

Enum value maps for QueryRequest_Trinary.

var File_go_chromium_org_luci_logdog_api_endpoints_coordinator_logs_v1_logs_proto protoreflect.FileDescriptor
var File_go_chromium_org_luci_logdog_api_endpoints_coordinator_logs_v1_state_proto protoreflect.FileDescriptor

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 RegisterLogsServer

func RegisterLogsServer(s prpc.Registrar, srv LogsServer)

type DecoratedLogs

type DecoratedLogs struct {
	// Service is the service to decorate.
	Service LogsServer
	// 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(ctx 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(ctx context.Context, methodName string, rsp proto.Message, err error) error
}

func (*DecoratedLogs) Get

func (s *DecoratedLogs) Get(ctx context.Context, req *GetRequest) (rsp *GetResponse, err error)

func (*DecoratedLogs) Query

func (s *DecoratedLogs) Query(ctx context.Context, req *QueryRequest) (rsp *QueryResponse, err error)

func (*DecoratedLogs) Tail

func (s *DecoratedLogs) Tail(ctx context.Context, req *TailRequest) (rsp *GetResponse, err error)

type GetRequest

type GetRequest struct {

	// The request project to request.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The path of the log stream to get.
	//
	// This can either be a LogDog stream path or the SHA256 hash of a LogDog
	// stream path.
	//
	// Some utilities may find passing around a full LogDog path to be cumbersome
	// due to its length. They can opt to pass around the hash instead and
	// retrieve logs using it.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// If true, requests that the log stream's state is returned.
	State bool `protobuf:"varint,3,opt,name=state,proto3" json:"state,omitempty"`
	// The initial log stream index to retrieve.
	Index int64 `protobuf:"varint,4,opt,name=index,proto3" json:"index,omitempty"`
	// The maximum number of bytes to return. If non-zero, it is applied as a
	// constraint to limit the number of logs that are returned.
	//
	// This only returns complete logs. Assuming logs are available, it will
	// return at least one log (even if it violates the size constraint) and as
	// many additional logs as it can without exceeding this constraint.
	ByteCount int32 `protobuf:"varint,5,opt,name=byte_count,json=byteCount,proto3" json:"byte_count,omitempty"`
	// The maximum number of log records to request.
	//
	// If this value is zero, no count constraint will be applied. If this value
	// is less than zero, no log entries will be returned. This can be used to
	// fetch log stream descriptors without fetching any log records.
	LogCount int32 `protobuf:"varint,6,opt,name=log_count,json=logCount,proto3" json:"log_count,omitempty"`
	// If true, allows the range request to return non-contiguous records.
	//
	// A contiguous request (default) will iterate forwards from the supplied
	// Index and stop if either the end of stream is encountered or there is a
	// missing stream index. A NonContiguous request will remove the latter
	// condition.
	//
	// For example, say the log stream consists of:
	// [3, 4, 6, 7]
	//
	// A contiguous request with Index 3 will return: [3, 4], stopping because
	// 5 is missing. A non-contiguous request will return [3, 4, 6, 7].
	NonContiguous bool                       `protobuf:"varint,7,opt,name=non_contiguous,json=nonContiguous,proto3" json:"non_contiguous,omitempty"`
	GetSignedUrls *GetRequest_SignURLRequest `protobuf:"bytes,8,opt,name=get_signed_urls,json=getSignedUrls,proto3" json:"get_signed_urls,omitempty"`
	// contains filtered or unexported fields
}

GetRequest is the request structure for the user Get endpoint.

If the requested log stream exists, a valid GetRequest will succeed regardless of whether the requested log range was available.

Note that this endpoint may return fewer logs than requested due to either availability or internal constraints.

func (*GetRequest) Descriptor

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

Deprecated: Use GetRequest.ProtoReflect.Descriptor instead.

func (*GetRequest) GetByteCount

func (x *GetRequest) GetByteCount() int32

func (*GetRequest) GetGetSignedUrls

func (x *GetRequest) GetGetSignedUrls() *GetRequest_SignURLRequest

func (*GetRequest) GetIndex

func (x *GetRequest) GetIndex() int64

func (*GetRequest) GetLogCount

func (x *GetRequest) GetLogCount() int32

func (*GetRequest) GetMessageProject

func (r *GetRequest) GetMessageProject() string

GetMessageProject implements ProjectBoundMessage.

func (*GetRequest) GetNonContiguous

func (x *GetRequest) GetNonContiguous() bool

func (*GetRequest) GetPath

func (x *GetRequest) GetPath() string

func (*GetRequest) GetProject

func (x *GetRequest) GetProject() string

func (*GetRequest) GetState

func (x *GetRequest) GetState() bool

func (*GetRequest) ProtoMessage

func (*GetRequest) ProtoMessage()

func (*GetRequest) ProtoReflect

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

func (*GetRequest) Reset

func (x *GetRequest) Reset()

func (*GetRequest) String

func (x *GetRequest) String() string

type GetRequest_SignURLRequest

type GetRequest_SignURLRequest struct {

	// The lifetime that the signed URL will be bound to.. The
	Lifetime *duration.Duration `protobuf:"bytes,1,opt,name=lifetime,proto3" json:"lifetime,omitempty"`
	// Return a signed URL for the log's RecordIO protobuf data.
	Stream bool `protobuf:"varint,2,opt,name=stream,proto3" json:"stream,omitempty"`
	// Return a signed URL for the log's LogIndex protobuf.
	Index bool `protobuf:"varint,3,opt,name=index,proto3" json:"index,omitempty"`
	// contains filtered or unexported fields
}

If supplied, the response will contain a SignedUrls message with the requested signed URLs. If signed URLs are not supported by the log's current storage system, the response message will be empty.

func (*GetRequest_SignURLRequest) Descriptor

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

Deprecated: Use GetRequest_SignURLRequest.ProtoReflect.Descriptor instead.

func (*GetRequest_SignURLRequest) GetIndex

func (x *GetRequest_SignURLRequest) GetIndex() bool

func (*GetRequest_SignURLRequest) GetLifetime

func (x *GetRequest_SignURLRequest) GetLifetime() *duration.Duration

func (*GetRequest_SignURLRequest) GetStream

func (x *GetRequest_SignURLRequest) GetStream() bool

func (*GetRequest_SignURLRequest) ProtoMessage

func (*GetRequest_SignURLRequest) ProtoMessage()

func (*GetRequest_SignURLRequest) ProtoReflect

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

func (*GetRequest_SignURLRequest) Reset

func (x *GetRequest_SignURLRequest) Reset()

func (*GetRequest_SignURLRequest) String

func (x *GetRequest_SignURLRequest) String() string

type GetResponse

type GetResponse struct {

	// Project is the project name that these logs belong to.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The log stream descriptor and state for this stream.
	//
	// It can be requested by setting the request's State field to true. If the
	// Proto field is true, the State's Descriptor field will not be included.
	State *LogStreamState `protobuf:"bytes,2,opt,name=state,proto3" json:"state,omitempty"`
	// The expanded LogStreamDescriptor protobuf. It is intended for JSON
	// consumption.
	//
	// If the GetRequest's Proto field is false, this will be populated;
	// otherwise, the serialized protobuf will be written to the DescriptorProto
	// field.
	Desc *logpb.LogStreamDescriptor `protobuf:"bytes,3,opt,name=desc,proto3" json:"desc,omitempty"`
	// Log represents the set of retrieved log records.
	Logs []*logpb.LogEntry `protobuf:"bytes,4,rep,name=logs,proto3" json:"logs,omitempty"`
	// An optional signed log entry RecordIO protobuf URL, if requested via
	// "sign_entry_url_lifetime".
	SignedUrls *GetResponse_SignedUrls `protobuf:"bytes,5,opt,name=signed_urls,json=signedUrls,proto3" json:"signed_urls,omitempty"`
	// contains filtered or unexported fields
}

GetResponse is the response structure for the user Get endpoint.

func (*GetResponse) Descriptor

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

Deprecated: Use GetResponse.ProtoReflect.Descriptor instead.

func (*GetResponse) GetDesc

func (x *GetResponse) GetDesc() *logpb.LogStreamDescriptor

func (*GetResponse) GetLogs

func (x *GetResponse) GetLogs() []*logpb.LogEntry

func (*GetResponse) GetProject

func (x *GetResponse) GetProject() string

func (*GetResponse) GetSignedUrls

func (x *GetResponse) GetSignedUrls() *GetResponse_SignedUrls

func (*GetResponse) GetState

func (x *GetResponse) GetState() *LogStreamState

func (*GetResponse) ProtoMessage

func (*GetResponse) ProtoMessage()

func (*GetResponse) ProtoReflect

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

func (*GetResponse) Reset

func (x *GetResponse) Reset()

func (*GetResponse) String

func (x *GetResponse) String() string

type GetResponse_SignedUrls

type GetResponse_SignedUrls struct {

	// The time when this signed URL will expire.
	Expiration *timestamp.Timestamp `protobuf:"bytes,1,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// The signed log stream URL, if requested.
	Stream string `protobuf:"bytes,2,opt,name=stream,proto3" json:"stream,omitempty"`
	// The signed log index URL, if requested.
	Index string `protobuf:"bytes,3,opt,name=index,proto3" json:"index,omitempty"`
	// contains filtered or unexported fields
}

Holds information about the log stream's signed entry URL.

func (*GetResponse_SignedUrls) Descriptor

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

Deprecated: Use GetResponse_SignedUrls.ProtoReflect.Descriptor instead.

func (*GetResponse_SignedUrls) GetExpiration

func (x *GetResponse_SignedUrls) GetExpiration() *timestamp.Timestamp

func (*GetResponse_SignedUrls) GetIndex

func (x *GetResponse_SignedUrls) GetIndex() string

func (*GetResponse_SignedUrls) GetStream

func (x *GetResponse_SignedUrls) GetStream() string

func (*GetResponse_SignedUrls) ProtoMessage

func (*GetResponse_SignedUrls) ProtoMessage()

func (*GetResponse_SignedUrls) ProtoReflect

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

func (*GetResponse_SignedUrls) Reset

func (x *GetResponse_SignedUrls) Reset()

func (*GetResponse_SignedUrls) String

func (x *GetResponse_SignedUrls) String() string

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 time when the log stream was registered with the Coordinator.
	Created *timestamp.Timestamp `protobuf:"bytes,2,opt,name=created,proto3" json:"created,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 non-nil, the log stream is archived, and this field contains archival
	// details.
	Archive *LogStreamState_ArchiveInfo `protobuf:"bytes,4,opt,name=archive,proto3" json:"archive,omitempty"`
	// Indicates the purged state of a log. A log that has been purged is only
	// acknowledged to administrative clients.
	Purged bool `protobuf:"varint,5,opt,name=purged,proto3" json:"purged,omitempty"`
	// contains filtered or unexported fields
}

LogStreamState is a bidirectional state value used in UpdateStream calls.

LogStreamState is embeddable in Endpoints request/response structs.

func (*LogStreamState) Descriptor

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

Deprecated: Use LogStreamState.ProtoReflect.Descriptor instead.

func (*LogStreamState) GetArchive

func (x *LogStreamState) GetArchive() *LogStreamState_ArchiveInfo

func (*LogStreamState) GetCreated

func (x *LogStreamState) GetCreated() *timestamp.Timestamp

func (*LogStreamState) GetProtoVersion

func (x *LogStreamState) GetProtoVersion() string

func (*LogStreamState) GetPurged

func (x *LogStreamState) GetPurged() bool

func (*LogStreamState) GetTerminalIndex

func (x *LogStreamState) GetTerminalIndex() int64

func (*LogStreamState) ProtoMessage

func (*LogStreamState) ProtoMessage()

func (*LogStreamState) ProtoReflect

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

func (*LogStreamState) Reset

func (x *LogStreamState) Reset()

func (*LogStreamState) String

func (x *LogStreamState) String() string

type LogStreamState_ArchiveInfo

type LogStreamState_ArchiveInfo struct {

	// The Google Storage URL where the log stream's index is archived.
	IndexUrl string `protobuf:"bytes,1,opt,name=index_url,json=indexUrl,proto3" json:"index_url,omitempty"`
	// The Google Storage URL where the log stream's raw stream data is archived.
	StreamUrl string `protobuf:"bytes,2,opt,name=stream_url,json=streamUrl,proto3" json:"stream_url,omitempty"`
	// The Google Storage URL where the log stream's assembled data is archived.
	DataUrl string `protobuf:"bytes,3,opt,name=data_url,json=dataUrl,proto3" json:"data_url,omitempty"`
	// If true, all log entries between 0 and terminal_index were archived. If
	// false, this indicates that the log stream was not completely loaded into
	// intermediate storage when the archival interval expired.
	Complete bool `protobuf:"varint,4,opt,name=complete,proto3" json:"complete,omitempty"`
	// The number of log
	LogEntryCount int64 `protobuf:"varint,5,opt,name=log_entry_count,json=logEntryCount,proto3" json:"log_entry_count,omitempty"`
	// contains filtered or unexported fields
}

ArchiveInfo contains archive details for the log stream.

func (*LogStreamState_ArchiveInfo) Descriptor

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

Deprecated: Use LogStreamState_ArchiveInfo.ProtoReflect.Descriptor instead.

func (*LogStreamState_ArchiveInfo) GetComplete

func (x *LogStreamState_ArchiveInfo) GetComplete() bool

func (*LogStreamState_ArchiveInfo) GetDataUrl

func (x *LogStreamState_ArchiveInfo) GetDataUrl() string

func (*LogStreamState_ArchiveInfo) GetIndexUrl

func (x *LogStreamState_ArchiveInfo) GetIndexUrl() string

func (*LogStreamState_ArchiveInfo) GetLogEntryCount

func (x *LogStreamState_ArchiveInfo) GetLogEntryCount() int64

func (*LogStreamState_ArchiveInfo) GetStreamUrl

func (x *LogStreamState_ArchiveInfo) GetStreamUrl() string

func (*LogStreamState_ArchiveInfo) ProtoMessage

func (*LogStreamState_ArchiveInfo) ProtoMessage()

func (*LogStreamState_ArchiveInfo) ProtoReflect

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

func (*LogStreamState_ArchiveInfo) Reset

func (x *LogStreamState_ArchiveInfo) Reset()

func (*LogStreamState_ArchiveInfo) String

func (x *LogStreamState_ArchiveInfo) String() string

type LogsClient

type LogsClient interface {
	// Get returns state and log data for a single log stream.
	Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)
	// Tail returns the last log in the log stream at the time of the request.
	Tail(ctx context.Context, in *TailRequest, opts ...grpc.CallOption) (*GetResponse, error)
	// Query returns log stream paths that match the requested query.
	Query(ctx context.Context, in *QueryRequest, opts ...grpc.CallOption) (*QueryResponse, error)
}

LogsClient is the client API for Logs service.

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

func NewLogsClient

func NewLogsClient(cc grpc.ClientConnInterface) LogsClient

func NewLogsPRPCClient

func NewLogsPRPCClient(client *prpc.Client) LogsClient

type LogsServer

type LogsServer interface {
	// Get returns state and log data for a single log stream.
	Get(context.Context, *GetRequest) (*GetResponse, error)
	// Tail returns the last log in the log stream at the time of the request.
	Tail(context.Context, *TailRequest) (*GetResponse, error)
	// Query returns log stream paths that match the requested query.
	Query(context.Context, *QueryRequest) (*QueryResponse, error)
}

LogsServer is the server API for Logs service.

type QueryRequest

type QueryRequest struct {
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`

	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`

	State bool `protobuf:"varint,3,opt,name=state,proto3" json:"state,omitempty"`

	Proto bool `protobuf:"varint,4,opt,name=proto,proto3" json:"proto,omitempty"`

	Next string `protobuf:"bytes,5,opt,name=next,proto3" json:"next,omitempty"`

	MaxResults int32 `protobuf:"varint,6,opt,name=max_results,json=maxResults,proto3" json:"max_results,omitempty"`

	ContentType string                         `protobuf:"bytes,10,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	StreamType  *QueryRequest_StreamTypeFilter `protobuf:"bytes,11,opt,name=stream_type,json=streamType,proto3" json:"stream_type,omitempty"`

	Newer *timestamp.Timestamp `protobuf:"bytes,12,opt,name=newer,proto3" json:"newer,omitempty"`

	Older *timestamp.Timestamp `protobuf:"bytes,13,opt,name=older,proto3" json:"older,omitempty"`

	Tags map[string]string "" /* 150 byte string literal not displayed */

	Purged QueryRequest_Trinary `protobuf:"varint,16,opt,name=purged,proto3,enum=logdog.QueryRequest_Trinary" json:"purged,omitempty"`

}

QueryRequest is the request structure for the user Query endpoint.

func (*QueryRequest) Descriptor

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

Deprecated: Use QueryRequest.ProtoReflect.Descriptor instead.

func (*QueryRequest) GetContentType

func (x *QueryRequest) GetContentType() string

func (*QueryRequest) GetMaxResults

func (x *QueryRequest) GetMaxResults() int32

func (*QueryRequest) GetMessageProject

func (r *QueryRequest) GetMessageProject() string

GetMessageProject implements ProjectBoundMessage.

func (*QueryRequest) GetNewer

func (x *QueryRequest) GetNewer() *timestamp.Timestamp

func (*QueryRequest) GetNext

func (x *QueryRequest) GetNext() string

func (*QueryRequest) GetOlder

func (x *QueryRequest) GetOlder() *timestamp.Timestamp

func (*QueryRequest) GetPath

func (x *QueryRequest) GetPath() string

func (*QueryRequest) GetProject

func (x *QueryRequest) GetProject() string

func (*QueryRequest) GetProto

func (x *QueryRequest) GetProto() bool

func (*QueryRequest) GetPurged

func (x *QueryRequest) GetPurged() QueryRequest_Trinary

func (*QueryRequest) GetState

func (x *QueryRequest) GetState() bool

func (*QueryRequest) GetStreamType

func (x *QueryRequest) GetStreamType() *QueryRequest_StreamTypeFilter

func (*QueryRequest) GetTags

func (x *QueryRequest) GetTags() map[string]string

func (*QueryRequest) ProtoMessage

func (*QueryRequest) ProtoMessage()

func (*QueryRequest) ProtoReflect

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

func (*QueryRequest) Reset

func (x *QueryRequest) Reset()

func (*QueryRequest) String

func (x *QueryRequest) String() string

type QueryRequest_StreamTypeFilter

type QueryRequest_StreamTypeFilter struct {

	// The StreamType value to filter on.
	Value logpb.StreamType `protobuf:"varint,1,opt,name=value,proto3,enum=logpb.StreamType" json:"value,omitempty"`
	// contains filtered or unexported fields
}

The stream type to filter on.

func (*QueryRequest_StreamTypeFilter) Descriptor

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

Deprecated: Use QueryRequest_StreamTypeFilter.ProtoReflect.Descriptor instead.

func (*QueryRequest_StreamTypeFilter) GetValue

func (x *QueryRequest_StreamTypeFilter) GetValue() logpb.StreamType

func (*QueryRequest_StreamTypeFilter) ProtoMessage

func (*QueryRequest_StreamTypeFilter) ProtoMessage()

func (*QueryRequest_StreamTypeFilter) ProtoReflect

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

func (*QueryRequest_StreamTypeFilter) Reset

func (x *QueryRequest_StreamTypeFilter) Reset()

func (*QueryRequest_StreamTypeFilter) String

func (x *QueryRequest_StreamTypeFilter) String() string

type QueryRequest_Trinary

type QueryRequest_Trinary int32

Trinary represents a trinary value.

const (
	// Both positive and negative results will be returned.
	QueryRequest_BOTH QueryRequest_Trinary = 0
	// Only positive results will be returned.
	QueryRequest_YES QueryRequest_Trinary = 1
	// Only negative results will be returned.
	QueryRequest_NO QueryRequest_Trinary = 2
)

func (QueryRequest_Trinary) Descriptor

func (QueryRequest_Trinary) Descriptor() protoreflect.EnumDescriptor

func (QueryRequest_Trinary) Enum

func (x QueryRequest_Trinary) Enum() *QueryRequest_Trinary

func (QueryRequest_Trinary) EnumDescriptor

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

Deprecated: Use QueryRequest_Trinary.Descriptor instead.

func (QueryRequest_Trinary) Number

func (x QueryRequest_Trinary) Number() protoreflect.EnumNumber

func (QueryRequest_Trinary) String

func (x QueryRequest_Trinary) String() string

func (QueryRequest_Trinary) Type

func (QueryRequest_Trinary) Type() protoreflect.EnumType

type QueryResponse

type QueryResponse struct {

	// Project is the project name that all responses belong to.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The list of streams that were identified as the result of the query.
	Streams []*QueryResponse_Stream `protobuf:"bytes,2,rep,name=streams,proto3" json:"streams,omitempty"`
	// If not empty, indicates that there are more query results available.
	// These results can be requested by repeating the Query request with the
	// same Path field and supplying this value in the Next field.
	Next string `protobuf:"bytes,3,opt,name=next,proto3" json:"next,omitempty"`
	// contains filtered or unexported fields
}

QueryResponse is the response structure for the user Query endpoint.

func (*QueryResponse) Descriptor

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

Deprecated: Use QueryResponse.ProtoReflect.Descriptor instead.

func (*QueryResponse) GetNext

func (x *QueryResponse) GetNext() string

func (*QueryResponse) GetProject

func (x *QueryResponse) GetProject() string

func (*QueryResponse) GetStreams

func (x *QueryResponse) GetStreams() []*QueryResponse_Stream

func (*QueryResponse) ProtoMessage

func (*QueryResponse) ProtoMessage()

func (*QueryResponse) ProtoReflect

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

func (*QueryResponse) Reset

func (x *QueryResponse) Reset()

func (*QueryResponse) String

func (x *QueryResponse) String() string

type QueryResponse_Stream

type QueryResponse_Stream struct {

	// Path is the log stream path.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// State is the log stream descriptor and state for this stream.
	//
	// It can be requested by setting the request's State field to true. If the
	// Proto field is true, the State's Descriptor field will not be included.
	State *LogStreamState `protobuf:"bytes,2,opt,name=state,proto3" json:"state,omitempty"`
	// The JSON-packed log stream descriptor protobuf.
	//
	// A Descriptor entry corresponds to the Path with the same index.
	//
	// If the query request's State field is set, the descriptor will be
	// populated. If the Proto field is false, Descriptor will be populated;
	// otherwise, DescriptorProto will be populated with the serialized descriptor
	// protobuf.
	Desc *logpb.LogStreamDescriptor `protobuf:"bytes,3,opt,name=desc,proto3" json:"desc,omitempty"`
	// The serialized log stream Descriptor protobuf.
	DescProto []byte `protobuf:"bytes,4,opt,name=desc_proto,json=descProto,proto3" json:"desc_proto,omitempty"`
	// contains filtered or unexported fields
}

Stream represents a single query response stream.

func (*QueryResponse_Stream) Descriptor

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

Deprecated: Use QueryResponse_Stream.ProtoReflect.Descriptor instead.

func (*QueryResponse_Stream) GetDesc

func (x *QueryResponse_Stream) GetDesc() *logpb.LogStreamDescriptor

func (*QueryResponse_Stream) GetDescProto

func (x *QueryResponse_Stream) GetDescProto() []byte

func (*QueryResponse_Stream) GetPath

func (x *QueryResponse_Stream) GetPath() string

func (*QueryResponse_Stream) GetState

func (x *QueryResponse_Stream) GetState() *LogStreamState

func (*QueryResponse_Stream) ProtoMessage

func (*QueryResponse_Stream) ProtoMessage()

func (*QueryResponse_Stream) ProtoReflect

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

func (*QueryResponse_Stream) Reset

func (x *QueryResponse_Stream) Reset()

func (*QueryResponse_Stream) String

func (x *QueryResponse_Stream) String() string

type TailRequest

type TailRequest struct {

	// The request project to request.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The path of the log stream to get.
	//
	// This can either be a LogDog stream path or the SHA256 hash of a LogDog
	// stream path.
	//
	// Some utilities may find passing around a full LogDog path to be cumbersome
	// due to its length. They can opt to pass around the hash instead and
	// retrieve logs using it.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// If true, requests that the log stream's state is returned.
	State bool `protobuf:"varint,3,opt,name=state,proto3" json:"state,omitempty"`
	// contains filtered or unexported fields
}

TailRequest is the request structure for the user Tail endpoint. It returns the last log in a given log stream at the time of the request.

func (*TailRequest) Descriptor

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

Deprecated: Use TailRequest.ProtoReflect.Descriptor instead.

func (*TailRequest) GetMessageProject

func (r *TailRequest) GetMessageProject() string

GetMessageProject implements ProjectBoundMessage.

func (*TailRequest) GetPath

func (x *TailRequest) GetPath() string

func (*TailRequest) GetProject

func (x *TailRequest) GetProject() string

func (*TailRequest) GetState

func (x *TailRequest) GetState() bool

func (*TailRequest) ProtoMessage

func (*TailRequest) ProtoMessage()

func (*TailRequest) ProtoReflect

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

func (*TailRequest) Reset

func (x *TailRequest) Reset()

func (*TailRequest) String

func (x *TailRequest) String() string

type UnimplementedLogsServer

type UnimplementedLogsServer struct {
}

UnimplementedLogsServer can be embedded to have forward compatible implementations.

func (*UnimplementedLogsServer) Get

func (*UnimplementedLogsServer) Get(context.Context, *GetRequest) (*GetResponse, error)

func (*UnimplementedLogsServer) Query

func (*UnimplementedLogsServer) Query(context.Context, *QueryRequest) (*QueryResponse, error)

func (*UnimplementedLogsServer) Tail

func (*UnimplementedLogsServer) Tail(context.Context, *TailRequest) (*GetResponse, error)

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier