remotelogstream

Documentation

Index

• Variables
• func RegisterLogStreamServiceServer(s *grpc.Server, srv LogStreamServiceServer)
• type CreateLogStreamRequest
  • func (*CreateLogStreamRequest) Descriptor() ([]byte, []int)
  • func (x *CreateLogStreamRequest) GetParent() string
  • func (*CreateLogStreamRequest) ProtoMessage()
  • func (x *CreateLogStreamRequest) ProtoReflect() protoreflect.Message
  • func (x *CreateLogStreamRequest) Reset()
  • func (x *CreateLogStreamRequest) String() string
• type LogStream
  • func (*LogStream) Descriptor() ([]byte, []int)
  • func (x *LogStream) GetName() string
  • func (x *LogStream) GetWriteResourceName() string
  • func (*LogStream) ProtoMessage()
  • func (x *LogStream) ProtoReflect() protoreflect.Message
  • func (x *LogStream) Reset()
  • func (x *LogStream) String() string
• type LogStreamServiceClient
  • func NewLogStreamServiceClient(cc grpc.ClientConnInterface) LogStreamServiceClient
• type LogStreamServiceServer
• type UnimplementedLogStreamServiceServer
  • func (*UnimplementedLogStreamServiceServer) CreateLogStream(context.Context, *CreateLogStreamRequest) (*LogStream, error)

Variables

var File_build_bazel_remote_logstream_v1_remote_logstream_proto protoreflect.FileDescriptor

Functions

func RegisterLogStreamServiceServer

func RegisterLogStreamServiceServer(s *grpc.Server, srv LogStreamServiceServer)

Types

type CreateLogStreamRequest

type CreateLogStreamRequest struct {

	// Required. The parent resource of the created LogStream.
	// The list of valid types of parent resources of LogStreams is up to the
	// implementing server.
	// Example: projects/123
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

Contains all information necessary to create a new LogStream resource.

func (*CreateLogStreamRequest) Descriptor

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

Deprecated: Use CreateLogStreamRequest.ProtoReflect.Descriptor instead.

func (*CreateLogStreamRequest) GetParent

func (x *CreateLogStreamRequest) GetParent() string

func (*CreateLogStreamRequest) ProtoMessage

func (*CreateLogStreamRequest) ProtoMessage()

func (*CreateLogStreamRequest) ProtoReflect

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

func (*CreateLogStreamRequest) Reset

func (x *CreateLogStreamRequest) Reset()

func (*CreateLogStreamRequest) String

func (x *CreateLogStreamRequest) String() string

type LogStream

type LogStream struct {

	// Structured name of the resource in the format:
	//
	//	{parent=**}/logstreams/{logstream_id}
	//	Example: projects/123/logstreams/456-def
	//
	// Attempting to call the Byte Stream API's `Write` RPC with a LogStream's
	//
	//	`name` as the value for `ByteStream.Write.resource_name` is an error.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Resource name to pass to `ByteStream.Write` in the format:
	//
	//	{parent=**}/logstreams/{logstream_id}/{write_token}
	//	Example: projects/123/logstreams/456-def/789-ghi
	//
	// Attempting to call the Byte Stream API's `Read` RPC with a LogStream's
	//
	//	`write_resource_name` as the value for `ByteStream.Write.resource_name`
	//	is an error.
	//
	// `write_resource_name` is separate from `name` to ensure that only the
	// intended writers can write to a given LogStream. Writers must address write
	// operations to the `write_resource_name`, not the `name`, and must have
	// permission to write LogStreams. `write_resource_name` embeds a secret token
	// and should be protected accordingly; a mishandled `write_resource_name` can
	// result in unintended writers corrupting the LogStream. Therefore, the field
	// should be excluded from calls to any calls which retrieve LogStream
	// metadata (i.e.: `GetLogStream`).
	//
	// Bytes written to this resource must to be readable when `ByteStream.Read`
	// is called with the `name` resource.
	// Reading a write_resource_name must return an INVALID_ARGUMENT error.
	WriteResourceName string `protobuf:"bytes,2,opt,name=write_resource_name,json=writeResourceName,proto3" json:"write_resource_name,omitempty"`
	// contains filtered or unexported fields
}

A handle to a log (an ordered sequence of bytes).

func (*LogStream) Descriptor

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

Deprecated: Use LogStream.ProtoReflect.Descriptor instead.

func (*LogStream) GetName

func (x *LogStream) GetName() string

func (*LogStream) GetWriteResourceName

func (x *LogStream) GetWriteResourceName() string

func (*LogStream) ProtoMessage

func (*LogStream) ProtoMessage()

func (*LogStream) ProtoReflect

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

func (*LogStream) Reset

func (x *LogStream) Reset()

func (*LogStream) String

func (x *LogStream) String() string

type LogStreamServiceClient

type LogStreamServiceClient interface {
	// Create a LogStream which may be written to.
	//
	// The returned LogStream resource name will include a `write_resource_name`
	// which is the resource to use when writing to the LogStream.
	// Callers of CreateLogStream are expected to NOT publish the
	// `write_resource_name`.
	CreateLogStream(ctx context.Context, in *CreateLogStreamRequest, opts ...grpc.CallOption) (*LogStream, error)
}

LogStreamServiceClient is the client API for LogStreamService service.

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

func NewLogStreamServiceClient

func NewLogStreamServiceClient(cc grpc.ClientConnInterface) LogStreamServiceClient

type LogStreamServiceServer

type LogStreamServiceServer interface {
	// Create a LogStream which may be written to.
	//
	// The returned LogStream resource name will include a `write_resource_name`
	// which is the resource to use when writing to the LogStream.
	// Callers of CreateLogStream are expected to NOT publish the
	// `write_resource_name`.
	CreateLogStream(context.Context, *CreateLogStreamRequest) (*LogStream, error)
}

LogStreamServiceServer is the server API for LogStreamService service.

type UnimplementedLogStreamServiceServer

type UnimplementedLogStreamServiceServer struct {
}

UnimplementedLogStreamServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedLogStreamServiceServer) CreateLogStream

func (*UnimplementedLogStreamServiceServer) CreateLogStream(context.Context, *CreateLogStreamRequest) (*LogStream, error)