luci: go.chromium.org/luci/logdog/api/endpoints/coordinator/logs/v1 Index | Files | Directories

package logdog

import "go.chromium.org/luci/logdog/api/endpoints/coordinator/logs/v1"

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

Package Files

gen.go logs.pb.go logsserver_dec.go pb.discovery.go state.pb.go util.go

Variables

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

func FileDescriptorSet Uses

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 Uses

func RegisterLogsServer(s prpc.Registrar, srv LogsServer)

type DecoratedLogs Uses

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(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 (*DecoratedLogs) Get Uses

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

func (*DecoratedLogs) Query Uses

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

func (*DecoratedLogs) Tail Uses

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

type GetRequest Uses

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"`
    XXX_NoUnkeyedLiteral struct{}                   `json:"-"`
    XXX_unrecognized     []byte                     `json:"-"`
    XXX_sizecache        int32                      `json:"-"`
}

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 Uses

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

func (*GetRequest) GetByteCount Uses

func (m *GetRequest) GetByteCount() int32

func (*GetRequest) GetGetSignedUrls Uses

func (m *GetRequest) GetGetSignedUrls() *GetRequest_SignURLRequest

func (*GetRequest) GetIndex Uses

func (m *GetRequest) GetIndex() int64

func (*GetRequest) GetLogCount Uses

func (m *GetRequest) GetLogCount() int32

func (*GetRequest) GetMessageProject Uses

func (r *GetRequest) GetMessageProject() string

GetMessageProject implements ProjectBoundMessage.

func (*GetRequest) GetNonContiguous Uses

func (m *GetRequest) GetNonContiguous() bool

func (*GetRequest) GetPath Uses

func (m *GetRequest) GetPath() string

func (*GetRequest) GetProject Uses

func (m *GetRequest) GetProject() string

func (*GetRequest) GetState Uses

func (m *GetRequest) GetState() bool

func (*GetRequest) ProtoMessage Uses

func (*GetRequest) ProtoMessage()

func (*GetRequest) Reset Uses

func (m *GetRequest) Reset()

func (*GetRequest) String Uses

func (m *GetRequest) String() string

func (*GetRequest) XXX_DiscardUnknown Uses

func (m *GetRequest) XXX_DiscardUnknown()

func (*GetRequest) XXX_Marshal Uses

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

func (*GetRequest) XXX_Merge Uses

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

func (*GetRequest) XXX_Size Uses

func (m *GetRequest) XXX_Size() int

func (*GetRequest) XXX_Unmarshal Uses

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

type GetRequest_SignURLRequest Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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 Uses

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

func (*GetRequest_SignURLRequest) GetIndex Uses

func (m *GetRequest_SignURLRequest) GetIndex() bool

func (*GetRequest_SignURLRequest) GetLifetime Uses

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

func (*GetRequest_SignURLRequest) GetStream Uses

func (m *GetRequest_SignURLRequest) GetStream() bool

func (*GetRequest_SignURLRequest) ProtoMessage Uses

func (*GetRequest_SignURLRequest) ProtoMessage()

func (*GetRequest_SignURLRequest) Reset Uses

func (m *GetRequest_SignURLRequest) Reset()

func (*GetRequest_SignURLRequest) String Uses

func (m *GetRequest_SignURLRequest) String() string

func (*GetRequest_SignURLRequest) XXX_DiscardUnknown Uses

func (m *GetRequest_SignURLRequest) XXX_DiscardUnknown()

func (*GetRequest_SignURLRequest) XXX_Marshal Uses

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

func (*GetRequest_SignURLRequest) XXX_Merge Uses

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

func (*GetRequest_SignURLRequest) XXX_Size Uses

func (m *GetRequest_SignURLRequest) XXX_Size() int

func (*GetRequest_SignURLRequest) XXX_Unmarshal Uses

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

type GetResponse Uses

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"`
    XXX_NoUnkeyedLiteral struct{}                `json:"-"`
    XXX_unrecognized     []byte                  `json:"-"`
    XXX_sizecache        int32                   `json:"-"`
}

GetResponse is the response structure for the user Get endpoint.

func (*GetResponse) Descriptor Uses

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

func (*GetResponse) GetDesc Uses

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

func (*GetResponse) GetLogs Uses

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

func (*GetResponse) GetProject Uses

func (m *GetResponse) GetProject() string

func (*GetResponse) GetSignedUrls Uses

func (m *GetResponse) GetSignedUrls() *GetResponse_SignedUrls

func (*GetResponse) GetState Uses

func (m *GetResponse) GetState() *LogStreamState

func (*GetResponse) ProtoMessage Uses

func (*GetResponse) ProtoMessage()

func (*GetResponse) Reset Uses

func (m *GetResponse) Reset()

func (*GetResponse) String Uses

func (m *GetResponse) String() string

func (*GetResponse) XXX_DiscardUnknown Uses

func (m *GetResponse) XXX_DiscardUnknown()

func (*GetResponse) XXX_Marshal Uses

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

func (*GetResponse) XXX_Merge Uses

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

func (*GetResponse) XXX_Size Uses

func (m *GetResponse) XXX_Size() int

func (*GetResponse) XXX_Unmarshal Uses

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

type GetResponse_SignedUrls Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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

func (*GetResponse_SignedUrls) Descriptor Uses

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

func (*GetResponse_SignedUrls) GetExpiration Uses

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

func (*GetResponse_SignedUrls) GetIndex Uses

func (m *GetResponse_SignedUrls) GetIndex() string

func (*GetResponse_SignedUrls) GetStream Uses

func (m *GetResponse_SignedUrls) GetStream() string

func (*GetResponse_SignedUrls) ProtoMessage Uses

func (*GetResponse_SignedUrls) ProtoMessage()

func (*GetResponse_SignedUrls) Reset Uses

func (m *GetResponse_SignedUrls) Reset()

func (*GetResponse_SignedUrls) String Uses

func (m *GetResponse_SignedUrls) String() string

func (*GetResponse_SignedUrls) XXX_DiscardUnknown Uses

func (m *GetResponse_SignedUrls) XXX_DiscardUnknown()

func (*GetResponse_SignedUrls) XXX_Marshal Uses

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

func (*GetResponse_SignedUrls) XXX_Merge Uses

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

func (*GetResponse_SignedUrls) XXX_Size Uses

func (m *GetResponse_SignedUrls) XXX_Size() int

func (*GetResponse_SignedUrls) XXX_Unmarshal Uses

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

type LogStreamState Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

LogStreamState is a bidirectional state value used in UpdateStream calls.

LogStreamState is embeddable in Endpoints request/response structs.

func (*LogStreamState) Descriptor Uses

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

func (*LogStreamState) GetArchive Uses

func (m *LogStreamState) GetArchive() *LogStreamState_ArchiveInfo

func (*LogStreamState) GetCreated Uses

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

func (*LogStreamState) GetProtoVersion Uses

func (m *LogStreamState) GetProtoVersion() string

func (*LogStreamState) GetPurged Uses

func (m *LogStreamState) GetPurged() bool

func (*LogStreamState) GetTerminalIndex Uses

func (m *LogStreamState) GetTerminalIndex() int64

func (*LogStreamState) ProtoMessage Uses

func (*LogStreamState) ProtoMessage()

func (*LogStreamState) Reset Uses

func (m *LogStreamState) Reset()

func (*LogStreamState) String Uses

func (m *LogStreamState) String() string

func (*LogStreamState) XXX_DiscardUnknown Uses

func (m *LogStreamState) XXX_DiscardUnknown()

func (*LogStreamState) XXX_Marshal Uses

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

func (*LogStreamState) XXX_Merge Uses

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

func (*LogStreamState) XXX_Size Uses

func (m *LogStreamState) XXX_Size() int

func (*LogStreamState) XXX_Unmarshal Uses

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

type LogStreamState_ArchiveInfo Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

ArchiveInfo contains archive details for the log stream.

func (*LogStreamState_ArchiveInfo) Descriptor Uses

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

func (*LogStreamState_ArchiveInfo) GetComplete Uses

func (m *LogStreamState_ArchiveInfo) GetComplete() bool

func (*LogStreamState_ArchiveInfo) GetDataUrl Uses

func (m *LogStreamState_ArchiveInfo) GetDataUrl() string

func (*LogStreamState_ArchiveInfo) GetIndexUrl Uses

func (m *LogStreamState_ArchiveInfo) GetIndexUrl() string

func (*LogStreamState_ArchiveInfo) GetLogEntryCount Uses

func (m *LogStreamState_ArchiveInfo) GetLogEntryCount() int64

func (*LogStreamState_ArchiveInfo) GetStreamUrl Uses

func (m *LogStreamState_ArchiveInfo) GetStreamUrl() string

func (*LogStreamState_ArchiveInfo) ProtoMessage Uses

func (*LogStreamState_ArchiveInfo) ProtoMessage()

func (*LogStreamState_ArchiveInfo) Reset Uses

func (m *LogStreamState_ArchiveInfo) Reset()

func (*LogStreamState_ArchiveInfo) String Uses

func (m *LogStreamState_ArchiveInfo) String() string

func (*LogStreamState_ArchiveInfo) XXX_DiscardUnknown Uses

func (m *LogStreamState_ArchiveInfo) XXX_DiscardUnknown()

func (*LogStreamState_ArchiveInfo) XXX_Marshal Uses

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

func (*LogStreamState_ArchiveInfo) XXX_Merge Uses

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

func (*LogStreamState_ArchiveInfo) XXX_Size Uses

func (m *LogStreamState_ArchiveInfo) XXX_Size() int

func (*LogStreamState_ArchiveInfo) XXX_Unmarshal Uses

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

type LogsClient Uses

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 Uses

func NewLogsClient(cc *grpc.ClientConn) LogsClient

func NewLogsPRPCClient Uses

func NewLogsPRPCClient(client *prpc.Client) LogsClient

type LogsServer Uses

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 Uses

type QueryRequest struct {
    // The request project to request.
    Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
    // The query parameter.
    //
    // The path expression may substitute a glob ("*") for a specific path
    // component. That is, any stream that matches the remaining structure qualifies
    // regardless of its value in that specific positional field.
    //
    // An unbounded wildcard may appear as a component at the end of both the
    // prefix and name query components. "**" matches all remaining components.
    //
    // If the supplied path query does not contain a path separator ("+"), it will
    // be treated as if the prefix is "**".
    //
    // Examples:
    //   - Empty ("") will return all streams.
    //   - **/+/** will return all streams.
    //   - foo/bar/** will return all streams with the "foo/bar" prefix.
    //   - foo/bar/**/+/baz will return all streams beginning with the "foo/bar"
    //     prefix and named "baz" (e.g., "foo/bar/qux/lol/+/baz")
    //   - foo/bar/+/** will return all streams with a "foo/bar" prefix.
    //   - foo/*/+/baz will return all streams with a two-component prefix whose
    //     first value is "foo" and whose name is "baz".
    //   - foo/bar will return all streams whose name is "foo/bar".
    //   - */* will return all streams with two-component names.
    Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
    // If true, returns that the streams' full state is returned instead of just
    // its Path.
    State bool `protobuf:"varint,3,opt,name=state,proto3" json:"state,omitempty"`
    // If true, causes the requested state to be returned as serialized protobuf
    // data instead of deserialized JSON structures.
    Proto bool `protobuf:"varint,4,opt,name=proto,proto3" json:"proto,omitempty"`
    // Next, if not empty, indicates that this query should continue at the point
    // where the previous query left off.
    Next string `protobuf:"bytes,5,opt,name=next,proto3" json:"next,omitempty"`
    // MaxResults is the maximum number of query results to return.
    //
    // If MaxResults is zero, no upper bound will be indicated. However, the
    // returned result count is still be subject to internal constraints.
    MaxResults int32 `protobuf:"varint,6,opt,name=max_results,json=maxResults,proto3" json:"max_results,omitempty"`
    // ContentType, if not empty, restricts results to streams with the supplied
    // content type.
    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 restricts results to streams created after the specified date.
    Newer *timestamp.Timestamp `protobuf:"bytes,12,opt,name=newer,proto3" json:"newer,omitempty"`
    // Older restricts results to streams created before the specified date.
    Older *timestamp.Timestamp `protobuf:"bytes,13,opt,name=older,proto3" json:"older,omitempty"`
    // If not empty, constrains the results to those whose protobuf version string
    // matches the supplied version.
    ProtoVersion string `protobuf:"bytes,14,opt,name=proto_version,json=protoVersion,proto3" json:"proto_version,omitempty"`
    // Tags is the set of tags to constrain the query with.
    //
    // A Tag entry may either be:
    // - A key/value query, in which case the results are constrained by logs
    //   whose tag includes that key/value pair.
    // - A key with an missing (nil) value, in which case the results are
    //   constraints by logs that have that tag key, regardless of its value.
    Tags map[string]string `protobuf:"bytes,15,rep,name=tags,proto3" json:"tags,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // Purged restricts the query to streams that have or haven't been purged.
    Purged               QueryRequest_Trinary `protobuf:"varint,16,opt,name=purged,proto3,enum=logdog.QueryRequest_Trinary" json:"purged,omitempty"`
    XXX_NoUnkeyedLiteral struct{}             `json:"-"`
    XXX_unrecognized     []byte               `json:"-"`
    XXX_sizecache        int32                `json:"-"`
}

QueryRequest is the request structure for the user Query endpoint.

func (*QueryRequest) Descriptor Uses

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

func (*QueryRequest) GetContentType Uses

func (m *QueryRequest) GetContentType() string

func (*QueryRequest) GetMaxResults Uses

func (m *QueryRequest) GetMaxResults() int32

func (*QueryRequest) GetMessageProject Uses

func (r *QueryRequest) GetMessageProject() string

GetMessageProject implements ProjectBoundMessage.

func (*QueryRequest) GetNewer Uses

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

func (*QueryRequest) GetNext Uses

func (m *QueryRequest) GetNext() string

func (*QueryRequest) GetOlder Uses

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

func (*QueryRequest) GetPath Uses

func (m *QueryRequest) GetPath() string

func (*QueryRequest) GetProject Uses

func (m *QueryRequest) GetProject() string

func (*QueryRequest) GetProto Uses

func (m *QueryRequest) GetProto() bool

func (*QueryRequest) GetProtoVersion Uses

func (m *QueryRequest) GetProtoVersion() string

func (*QueryRequest) GetPurged Uses

func (m *QueryRequest) GetPurged() QueryRequest_Trinary

func (*QueryRequest) GetState Uses

func (m *QueryRequest) GetState() bool

func (*QueryRequest) GetStreamType Uses

func (m *QueryRequest) GetStreamType() *QueryRequest_StreamTypeFilter

func (*QueryRequest) GetTags Uses

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

func (*QueryRequest) ProtoMessage Uses

func (*QueryRequest) ProtoMessage()

func (*QueryRequest) Reset Uses

func (m *QueryRequest) Reset()

func (*QueryRequest) String Uses

func (m *QueryRequest) String() string

func (*QueryRequest) XXX_DiscardUnknown Uses

func (m *QueryRequest) XXX_DiscardUnknown()

func (*QueryRequest) XXX_Marshal Uses

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

func (*QueryRequest) XXX_Merge Uses

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

func (*QueryRequest) XXX_Size Uses

func (m *QueryRequest) XXX_Size() int

func (*QueryRequest) XXX_Unmarshal Uses

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

type QueryRequest_StreamTypeFilter Uses

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"`
    XXX_NoUnkeyedLiteral struct{}         `json:"-"`
    XXX_unrecognized     []byte           `json:"-"`
    XXX_sizecache        int32            `json:"-"`
}

The stream type to filter on.

func (*QueryRequest_StreamTypeFilter) Descriptor Uses

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

func (*QueryRequest_StreamTypeFilter) GetValue Uses

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

func (*QueryRequest_StreamTypeFilter) ProtoMessage Uses

func (*QueryRequest_StreamTypeFilter) ProtoMessage()

func (*QueryRequest_StreamTypeFilter) Reset Uses

func (m *QueryRequest_StreamTypeFilter) Reset()

func (*QueryRequest_StreamTypeFilter) String Uses

func (m *QueryRequest_StreamTypeFilter) String() string

func (*QueryRequest_StreamTypeFilter) XXX_DiscardUnknown Uses

func (m *QueryRequest_StreamTypeFilter) XXX_DiscardUnknown()

func (*QueryRequest_StreamTypeFilter) XXX_Marshal Uses

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

func (*QueryRequest_StreamTypeFilter) XXX_Merge Uses

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

func (*QueryRequest_StreamTypeFilter) XXX_Size Uses

func (m *QueryRequest_StreamTypeFilter) XXX_Size() int

func (*QueryRequest_StreamTypeFilter) XXX_Unmarshal Uses

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

type QueryRequest_Trinary Uses

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) EnumDescriptor Uses

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

func (QueryRequest_Trinary) String Uses

func (x QueryRequest_Trinary) String() string

type QueryResponse Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

QueryResponse is the response structure for the user Query endpoint.

func (*QueryResponse) Descriptor Uses

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

func (*QueryResponse) GetNext Uses

func (m *QueryResponse) GetNext() string

func (*QueryResponse) GetProject Uses

func (m *QueryResponse) GetProject() string

func (*QueryResponse) GetStreams Uses

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

func (*QueryResponse) ProtoMessage Uses

func (*QueryResponse) ProtoMessage()

func (*QueryResponse) Reset Uses

func (m *QueryResponse) Reset()

func (*QueryResponse) String Uses

func (m *QueryResponse) String() string

func (*QueryResponse) XXX_DiscardUnknown Uses

func (m *QueryResponse) XXX_DiscardUnknown()

func (*QueryResponse) XXX_Marshal Uses

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

func (*QueryResponse) XXX_Merge Uses

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

func (*QueryResponse) XXX_Size Uses

func (m *QueryResponse) XXX_Size() int

func (*QueryResponse) XXX_Unmarshal Uses

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

type QueryResponse_Stream Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

Stream represents a single query response stream.

func (*QueryResponse_Stream) Descriptor Uses

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

func (*QueryResponse_Stream) GetDesc Uses

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

func (*QueryResponse_Stream) GetDescProto Uses

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

func (*QueryResponse_Stream) GetPath Uses

func (m *QueryResponse_Stream) GetPath() string

func (*QueryResponse_Stream) GetState Uses

func (m *QueryResponse_Stream) GetState() *LogStreamState

func (*QueryResponse_Stream) ProtoMessage Uses

func (*QueryResponse_Stream) ProtoMessage()

func (*QueryResponse_Stream) Reset Uses

func (m *QueryResponse_Stream) Reset()

func (*QueryResponse_Stream) String Uses

func (m *QueryResponse_Stream) String() string

func (*QueryResponse_Stream) XXX_DiscardUnknown Uses

func (m *QueryResponse_Stream) XXX_DiscardUnknown()

func (*QueryResponse_Stream) XXX_Marshal Uses

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

func (*QueryResponse_Stream) XXX_Merge Uses

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

func (*QueryResponse_Stream) XXX_Size Uses

func (m *QueryResponse_Stream) XXX_Size() int

func (*QueryResponse_Stream) XXX_Unmarshal Uses

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

type TailRequest Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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 Uses

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

func (*TailRequest) GetMessageProject Uses

func (r *TailRequest) GetMessageProject() string

GetMessageProject implements ProjectBoundMessage.

func (*TailRequest) GetPath Uses

func (m *TailRequest) GetPath() string

func (*TailRequest) GetProject Uses

func (m *TailRequest) GetProject() string

func (*TailRequest) GetState Uses

func (m *TailRequest) GetState() bool

func (*TailRequest) ProtoMessage Uses

func (*TailRequest) ProtoMessage()

func (*TailRequest) Reset Uses

func (m *TailRequest) Reset()

func (*TailRequest) String Uses

func (m *TailRequest) String() string

func (*TailRequest) XXX_DiscardUnknown Uses

func (m *TailRequest) XXX_DiscardUnknown()

func (*TailRequest) XXX_Marshal Uses

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

func (*TailRequest) XXX_Merge Uses

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

func (*TailRequest) XXX_Size Uses

func (m *TailRequest) XXX_Size() int

func (*TailRequest) XXX_Unmarshal Uses

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

Directories

PathSynopsis
fakelogs

Package logdog imports 12 packages (graph) and is imported by 8 packages. Updated 2018-10-19. Refresh now. Tools for package owners.