recordingsv1

package
v0.0.0-...-88e15ee Latest Latest
Warning

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

Go to latest
Published: May 8, 2023 License: ISC Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ContentHash_Alg_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "SHA256",
	}
	ContentHash_Alg_value = map[string]int32{
		"UNSPECIFIED": 0,
		"SHA256":      1,
	}
)

Enum value maps for ContentHash_Alg.

View Source
var (
	Recording_State_name = map[int32]string{
		0:  "UNKNOWN",
		1:  "IN_PROGRESS",
		2:  "ARCHIVING",
		3:  "ARCHIVING_FAILED",
		4:  "ARCHIVED",
		5:  "SANITY_CHECKING",
		6:  "SANITY_CHECKING_FAILED",
		7:  "SANITY_CHECKED",
		8:  "PROCESSING",
		9:  "PROCESSING_FAILED",
		10: "PROCESSED",
		11: "PUBLISHING",
		12: "PUBLISHING_FAILED",
		13: "PUBLISHED",
		14: "UPLOADING",
		15: "UPLOADING_FAILED",
		16: "UPLOADED",
		17: "READY",
		18: "BROKEN",
	}
	Recording_State_value = map[string]int32{
		"UNKNOWN":                0,
		"IN_PROGRESS":            1,
		"ARCHIVING":              2,
		"ARCHIVING_FAILED":       3,
		"ARCHIVED":               4,
		"SANITY_CHECKING":        5,
		"SANITY_CHECKING_FAILED": 6,
		"SANITY_CHECKED":         7,
		"PROCESSING":             8,
		"PROCESSING_FAILED":      9,
		"PROCESSED":              10,
		"PUBLISHING":             11,
		"PUBLISHING_FAILED":      12,
		"PUBLISHED":              13,
		"UPLOADING":              14,
		"UPLOADING_FAILED":       15,
		"UPLOADED":               16,
		"READY":                  17,
		"BROKEN":                 18,
	}
)

Enum value maps for Recording_State.

View Source
var File_recordings_v1_recordings_proto protoreflect.FileDescriptor
View Source
var Recordings_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "recordings.v1.Recordings",
	HandlerType: (*RecordingsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetRecording",
			Handler:    _Recordings_GetRecording_Handler,
		},
		{
			MethodName: "CreateRecording",
			Handler:    _Recordings_CreateRecording_Handler,
		},
		{
			MethodName: "UpdateRecording",
			Handler:    _Recordings_UpdateRecording_Handler,
		},
		{
			MethodName: "DeleteRecording",
			Handler:    _Recordings_DeleteRecording_Handler,
		},
		{
			MethodName: "ListRecordings",
			Handler:    _Recordings_ListRecordings_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "recordings/v1/recordings.proto",
}

Recordings_ServiceDesc is the grpc.ServiceDesc for Recordings service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var Uploads_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "recordings.v1.Uploads",
	HandlerType: (*UploadsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetUpload",
			Handler:    _Uploads_GetUpload_Handler,
		},
		{
			MethodName: "CreateUpload",
			Handler:    _Uploads_CreateUpload_Handler,
		},
		{
			MethodName: "UpdateUpload",
			Handler:    _Uploads_UpdateUpload_Handler,
		},
		{
			MethodName: "DeleteUpload",
			Handler:    _Uploads_DeleteUpload_Handler,
		},
		{
			MethodName: "ListUploads",
			Handler:    _Uploads_ListUploads_Handler,
		},
		{
			MethodName: "Write",
			Handler:    _Uploads_Write_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamingWrite",
			Handler:       _Uploads_StreamingWrite_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "recordings/v1/recordings.proto",
}

Uploads_ServiceDesc is the grpc.ServiceDesc for Uploads service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterRecordingsServer

func RegisterRecordingsServer(s grpc.ServiceRegistrar, srv RecordingsServer)

func RegisterUploadsServer

func RegisterUploadsServer(s grpc.ServiceRegistrar, srv UploadsServer)

Types

type ContentHash

type ContentHash struct {
	Alg   ContentHash_Alg `protobuf:"varint,1,opt,name=alg,proto3,enum=recordings.v1.ContentHash_Alg" json:"alg,omitempty"`
	Value []byte          `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ContentHash) Descriptor deprecated

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

Deprecated: Use ContentHash.ProtoReflect.Descriptor instead.

func (*ContentHash) GetAlg

func (x *ContentHash) GetAlg() ContentHash_Alg

func (*ContentHash) GetValue

func (x *ContentHash) GetValue() []byte

func (*ContentHash) ProtoMessage

func (*ContentHash) ProtoMessage()

func (*ContentHash) ProtoReflect

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

func (*ContentHash) Reset

func (x *ContentHash) Reset()

func (*ContentHash) String

func (x *ContentHash) String() string

type ContentHash_Alg

type ContentHash_Alg int32
const (
	ContentHash_UNSPECIFIED ContentHash_Alg = 0
	ContentHash_SHA256      ContentHash_Alg = 1
)

func (ContentHash_Alg) Descriptor

func (ContentHash_Alg) Enum

func (x ContentHash_Alg) Enum() *ContentHash_Alg

func (ContentHash_Alg) EnumDescriptor deprecated

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

Deprecated: Use ContentHash_Alg.Descriptor instead.

func (ContentHash_Alg) Number

func (ContentHash_Alg) String

func (x ContentHash_Alg) String() string

func (ContentHash_Alg) Type

type CreateRecordingRequest

type CreateRecordingRequest struct {
	Parent    string     `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	Recording *Recording `protobuf:"bytes,2,opt,name=recording,proto3" json:"recording,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateRecordingRequest) Descriptor deprecated

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

Deprecated: Use CreateRecordingRequest.ProtoReflect.Descriptor instead.

func (*CreateRecordingRequest) GetParent

func (x *CreateRecordingRequest) GetParent() string

func (*CreateRecordingRequest) GetRecording

func (x *CreateRecordingRequest) GetRecording() *Recording

func (*CreateRecordingRequest) ProtoMessage

func (*CreateRecordingRequest) ProtoMessage()

func (*CreateRecordingRequest) ProtoReflect

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

func (*CreateRecordingRequest) Reset

func (x *CreateRecordingRequest) Reset()

func (*CreateRecordingRequest) String

func (x *CreateRecordingRequest) String() string

type CreateUploadRequest

type CreateUploadRequest struct {
	Parent string  `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"` // the recording for which an upload is requested
	Upload *Upload `protobuf:"bytes,2,opt,name=upload,proto3" json:"upload,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateUploadRequest) Descriptor deprecated

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

Deprecated: Use CreateUploadRequest.ProtoReflect.Descriptor instead.

func (*CreateUploadRequest) GetParent

func (x *CreateUploadRequest) GetParent() string

func (*CreateUploadRequest) GetUpload

func (x *CreateUploadRequest) GetUpload() *Upload

func (*CreateUploadRequest) ProtoMessage

func (*CreateUploadRequest) ProtoMessage()

func (*CreateUploadRequest) ProtoReflect

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

func (*CreateUploadRequest) Reset

func (x *CreateUploadRequest) Reset()

func (*CreateUploadRequest) String

func (x *CreateUploadRequest) String() string

type DeleteRecordingRequest

type DeleteRecordingRequest struct {

	// Name identifies the resource to delete
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteRecordingRequest) Descriptor deprecated

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

Deprecated: Use DeleteRecordingRequest.ProtoReflect.Descriptor instead.

func (*DeleteRecordingRequest) GetName

func (x *DeleteRecordingRequest) GetName() string

func (*DeleteRecordingRequest) ProtoMessage

func (*DeleteRecordingRequest) ProtoMessage()

func (*DeleteRecordingRequest) ProtoReflect

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

func (*DeleteRecordingRequest) Reset

func (x *DeleteRecordingRequest) Reset()

func (*DeleteRecordingRequest) String

func (x *DeleteRecordingRequest) String() string

type DeleteUploadRequest

type DeleteUploadRequest struct {

	// Name identifies the resource to delete
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteUploadRequest) Descriptor deprecated

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

Deprecated: Use DeleteUploadRequest.ProtoReflect.Descriptor instead.

func (*DeleteUploadRequest) GetName

func (x *DeleteUploadRequest) GetName() string

func (*DeleteUploadRequest) ProtoMessage

func (*DeleteUploadRequest) ProtoMessage()

func (*DeleteUploadRequest) ProtoReflect

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

func (*DeleteUploadRequest) Reset

func (x *DeleteUploadRequest) Reset()

func (*DeleteUploadRequest) String

func (x *DeleteUploadRequest) String() string

type GetRecordingRequest

type GetRecordingRequest struct {

	// Name identifies the requested resource (e.g. recordings/$id)
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRecordingRequest) Descriptor deprecated

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

Deprecated: Use GetRecordingRequest.ProtoReflect.Descriptor instead.

func (*GetRecordingRequest) GetName

func (x *GetRecordingRequest) GetName() string

func (*GetRecordingRequest) ProtoMessage

func (*GetRecordingRequest) ProtoMessage()

func (*GetRecordingRequest) ProtoReflect

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

func (*GetRecordingRequest) Reset

func (x *GetRecordingRequest) Reset()

func (*GetRecordingRequest) String

func (x *GetRecordingRequest) String() string

type GetUploadRequest

type GetUploadRequest struct {

	// Name identifies the requested resource (e.g.
	// recordings/$rec_id/uploads/$upload_id)
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetUploadRequest) Descriptor deprecated

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

Deprecated: Use GetUploadRequest.ProtoReflect.Descriptor instead.

func (*GetUploadRequest) GetName

func (x *GetUploadRequest) GetName() string

func (*GetUploadRequest) ProtoMessage

func (*GetUploadRequest) ProtoMessage()

func (*GetUploadRequest) ProtoReflect

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

func (*GetUploadRequest) Reset

func (x *GetUploadRequest) Reset()

func (*GetUploadRequest) String

func (x *GetUploadRequest) String() string

type ListRecordingsRequest

type ListRecordingsRequest struct {

	// Parent specifies the parent collection to list.
	// BUG(ls): maybe some kind of filter expression?
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Page_size specifies the maximum number of recordings to return.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page_token describes the pagination offset, if any. Its value must
	// have been obtained from the response to a previous List request.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListRecordingsRequest) Descriptor deprecated

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

Deprecated: Use ListRecordingsRequest.ProtoReflect.Descriptor instead.

func (*ListRecordingsRequest) GetPageSize

func (x *ListRecordingsRequest) GetPageSize() int32

func (*ListRecordingsRequest) GetPageToken

func (x *ListRecordingsRequest) GetPageToken() string

func (*ListRecordingsRequest) GetParent

func (x *ListRecordingsRequest) GetParent() string

func (*ListRecordingsRequest) ProtoMessage

func (*ListRecordingsRequest) ProtoMessage()

func (*ListRecordingsRequest) ProtoReflect

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

func (*ListRecordingsRequest) Reset

func (x *ListRecordingsRequest) Reset()

func (*ListRecordingsRequest) String

func (x *ListRecordingsRequest) String() string

type ListRecordingsResponse

type ListRecordingsResponse struct {
	Recordings []*Recording `protobuf:"bytes,1,rep,name=recordings,proto3" json:"recordings,omitempty"`
	// Next_page_token is an opaque string that may be used in a subsequent call
	// to request the next page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListRecordingsResponse) Descriptor deprecated

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

Deprecated: Use ListRecordingsResponse.ProtoReflect.Descriptor instead.

func (*ListRecordingsResponse) GetNextPageToken

func (x *ListRecordingsResponse) GetNextPageToken() string

func (*ListRecordingsResponse) GetRecordings

func (x *ListRecordingsResponse) GetRecordings() []*Recording

func (*ListRecordingsResponse) ProtoMessage

func (*ListRecordingsResponse) ProtoMessage()

func (*ListRecordingsResponse) ProtoReflect

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

func (*ListRecordingsResponse) Reset

func (x *ListRecordingsResponse) Reset()

func (*ListRecordingsResponse) String

func (x *ListRecordingsResponse) String() string

type ListUploadsRequest

type ListUploadsRequest struct {
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

func (*ListUploadsRequest) Descriptor deprecated

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

Deprecated: Use ListUploadsRequest.ProtoReflect.Descriptor instead.

func (*ListUploadsRequest) GetParent

func (x *ListUploadsRequest) GetParent() string

func (*ListUploadsRequest) ProtoMessage

func (*ListUploadsRequest) ProtoMessage()

func (*ListUploadsRequest) ProtoReflect

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

func (*ListUploadsRequest) Reset

func (x *ListUploadsRequest) Reset()

func (*ListUploadsRequest) String

func (x *ListUploadsRequest) String() string

type ListUploadsResponse

type ListUploadsResponse struct {
	Uploads []*Upload `protobuf:"bytes,1,rep,name=uploads,proto3" json:"uploads,omitempty"`
	// contains filtered or unexported fields
}

func (*ListUploadsResponse) Descriptor deprecated

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

Deprecated: Use ListUploadsResponse.ProtoReflect.Descriptor instead.

func (*ListUploadsResponse) GetUploads

func (x *ListUploadsResponse) GetUploads() []*Upload

func (*ListUploadsResponse) ProtoMessage

func (*ListUploadsResponse) ProtoMessage()

func (*ListUploadsResponse) ProtoReflect

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

func (*ListUploadsResponse) Reset

func (x *ListUploadsResponse) Reset()

func (*ListUploadsResponse) String

func (x *ListUploadsResponse) String() string

type Recording

type Recording struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// opaque node identifier (commonly machine-id or hostname)
	Origin      string                 `protobuf:"bytes,2,opt,name=origin,proto3" json:"origin,omitempty"`
	State       Recording_State        `protobuf:"varint,3,opt,name=state,proto3,enum=recordings.v1.Recording_State" json:"state,omitempty"`
	ExternalId  string                 `protobuf:"bytes,4,opt,name=external_id,json=externalId,proto3" json:"external_id,omitempty"`
	PlaybackUrl string                 `protobuf:"bytes,5,opt,name=playback_url,json=playbackUrl,proto3" json:"playback_url,omitempty"`
	Metadata    []byte                 `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
	ContentHash *ContentHash           `protobuf:"bytes,7,opt,name=content_hash,json=contentHash,proto3" json:"content_hash,omitempty"` // read-only
	CreateTime  *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`   // read-only
	UpdateTime  *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`   // read-only
	// contains filtered or unexported fields
}

func (*Recording) Descriptor deprecated

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

Deprecated: Use Recording.ProtoReflect.Descriptor instead.

func (*Recording) GetContentHash

func (x *Recording) GetContentHash() *ContentHash

func (*Recording) GetCreateTime

func (x *Recording) GetCreateTime() *timestamppb.Timestamp

func (*Recording) GetExternalId

func (x *Recording) GetExternalId() string

func (*Recording) GetMetadata

func (x *Recording) GetMetadata() []byte

func (*Recording) GetName

func (x *Recording) GetName() string

func (*Recording) GetOrigin

func (x *Recording) GetOrigin() string

func (*Recording) GetPlaybackUrl

func (x *Recording) GetPlaybackUrl() string

func (*Recording) GetState

func (x *Recording) GetState() Recording_State

func (*Recording) GetUpdateTime

func (x *Recording) GetUpdateTime() *timestamppb.Timestamp

func (*Recording) ProtoMessage

func (*Recording) ProtoMessage()

func (*Recording) ProtoReflect

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

func (*Recording) Reset

func (x *Recording) Reset()

func (*Recording) String

func (x *Recording) String() string

type Recording_State

type Recording_State int32

BUG(ls): do we really want to expose the BBB recording states here?

const (
	Recording_UNKNOWN                Recording_State = 0
	Recording_IN_PROGRESS            Recording_State = 1
	Recording_ARCHIVING              Recording_State = 2
	Recording_ARCHIVING_FAILED       Recording_State = 3
	Recording_ARCHIVED               Recording_State = 4
	Recording_SANITY_CHECKING        Recording_State = 5
	Recording_SANITY_CHECKING_FAILED Recording_State = 6
	Recording_SANITY_CHECKED         Recording_State = 7
	Recording_PROCESSING             Recording_State = 8
	Recording_PROCESSING_FAILED      Recording_State = 9
	Recording_PROCESSED              Recording_State = 10
	Recording_PUBLISHING             Recording_State = 11
	Recording_PUBLISHING_FAILED      Recording_State = 12
	Recording_PUBLISHED              Recording_State = 13
	Recording_UPLOADING              Recording_State = 14
	Recording_UPLOADING_FAILED       Recording_State = 15
	Recording_UPLOADED               Recording_State = 16
	Recording_READY                  Recording_State = 17
	Recording_BROKEN                 Recording_State = 18
)

func (Recording_State) Descriptor

func (Recording_State) Enum

func (x Recording_State) Enum() *Recording_State

func (Recording_State) EnumDescriptor deprecated

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

Deprecated: Use Recording_State.Descriptor instead.

func (Recording_State) Number

func (Recording_State) String

func (x Recording_State) String() string

func (Recording_State) Type

type RecordingsClient

type RecordingsClient interface {
	// GetRecording returns the recording referred to by name or returns an
	// error.
	//
	// Erorrs:
	// NOT_FOUND: no such recording
	GetRecording(ctx context.Context, in *GetRecordingRequest, opts ...grpc.CallOption) (*Recording, error)
	// CreateRecording registers a new recording with the service.
	//
	// Errors:
	// ALREADY_EXISTS: a recording with name already exists
	// INVALID_ARGUMENT: recording is missing name,  origin or other
	// required field
	//
	// BUG(ls): allow caller to specify parent collection and think
	// whether we need more than a flat recordings namespace.
	CreateRecording(ctx context.Context, in *CreateRecordingRequest, opts ...grpc.CallOption) (*Recording, error)
	// UpdateRecording updates those fields of the recording specified by
	// update_mask.
	//
	// Errors:
	// NOT_FOUND: no such recording
	// INVALID_ARGUMENT: update mask is invalid or specifies immutable field
	UpdateRecording(ctx context.Context, in *UpdateRecordingRequest, opts ...grpc.CallOption) (*Recording, error)
	// DeleteRecording drops the specified recording from the service.
	//
	// Errors:
	// NOT_FOUND: no such recording
	DeleteRecording(ctx context.Context, in *DeleteRecordingRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// ListRecordings returns a maximum of page_size recordings in the
	// collection referred to by parent. It returns a next_page_token that
	// can be passed to a subsequent call.
	ListRecordings(ctx context.Context, in *ListRecordingsRequest, opts ...grpc.CallOption) (*ListRecordingsResponse, error)
}

RecordingsClient is the client API for Recordings service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewRecordingsClient

func NewRecordingsClient(cc grpc.ClientConnInterface) RecordingsClient

type RecordingsServer

type RecordingsServer interface {
	// GetRecording returns the recording referred to by name or returns an
	// error.
	//
	// Erorrs:
	// NOT_FOUND: no such recording
	GetRecording(context.Context, *GetRecordingRequest) (*Recording, error)
	// CreateRecording registers a new recording with the service.
	//
	// Errors:
	// ALREADY_EXISTS: a recording with name already exists
	// INVALID_ARGUMENT: recording is missing name,  origin or other
	// required field
	//
	// BUG(ls): allow caller to specify parent collection and think
	// whether we need more than a flat recordings namespace.
	CreateRecording(context.Context, *CreateRecordingRequest) (*Recording, error)
	// UpdateRecording updates those fields of the recording specified by
	// update_mask.
	//
	// Errors:
	// NOT_FOUND: no such recording
	// INVALID_ARGUMENT: update mask is invalid or specifies immutable field
	UpdateRecording(context.Context, *UpdateRecordingRequest) (*Recording, error)
	// DeleteRecording drops the specified recording from the service.
	//
	// Errors:
	// NOT_FOUND: no such recording
	DeleteRecording(context.Context, *DeleteRecordingRequest) (*emptypb.Empty, error)
	// ListRecordings returns a maximum of page_size recordings in the
	// collection referred to by parent. It returns a next_page_token that
	// can be passed to a subsequent call.
	ListRecordings(context.Context, *ListRecordingsRequest) (*ListRecordingsResponse, error)
	// contains filtered or unexported methods
}

RecordingsServer is the server API for Recordings service. All implementations must embed UnimplementedRecordingsServer for forward compatibility

type UnimplementedRecordingsServer

type UnimplementedRecordingsServer struct {
}

UnimplementedRecordingsServer must be embedded to have forward compatible implementations.

func (UnimplementedRecordingsServer) CreateRecording

func (UnimplementedRecordingsServer) DeleteRecording

func (UnimplementedRecordingsServer) GetRecording

func (UnimplementedRecordingsServer) ListRecordings

func (UnimplementedRecordingsServer) UpdateRecording

type UnimplementedUploadsServer

type UnimplementedUploadsServer struct {
}

UnimplementedUploadsServer must be embedded to have forward compatible implementations.

func (UnimplementedUploadsServer) CreateUpload

func (UnimplementedUploadsServer) DeleteUpload

func (UnimplementedUploadsServer) GetUpload

func (UnimplementedUploadsServer) ListUploads

func (UnimplementedUploadsServer) StreamingWrite

func (UnimplementedUploadsServer) UpdateUpload

func (UnimplementedUploadsServer) Write

type UnsafeRecordingsServer

type UnsafeRecordingsServer interface {
	// contains filtered or unexported methods
}

UnsafeRecordingsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RecordingsServer will result in compilation errors.

type UnsafeUploadsServer

type UnsafeUploadsServer interface {
	// contains filtered or unexported methods
}

UnsafeUploadsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to UploadsServer will result in compilation errors.

type UpdateRecordingRequest

type UpdateRecordingRequest struct {
	Recording  *Recording             `protobuf:"bytes,1,opt,name=recording,proto3" json:"recording,omitempty"`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateRecordingRequest) Descriptor deprecated

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

Deprecated: Use UpdateRecordingRequest.ProtoReflect.Descriptor instead.

func (*UpdateRecordingRequest) GetRecording

func (x *UpdateRecordingRequest) GetRecording() *Recording

func (*UpdateRecordingRequest) GetUpdateMask

func (x *UpdateRecordingRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateRecordingRequest) ProtoMessage

func (*UpdateRecordingRequest) ProtoMessage()

func (*UpdateRecordingRequest) ProtoReflect

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

func (*UpdateRecordingRequest) Reset

func (x *UpdateRecordingRequest) Reset()

func (*UpdateRecordingRequest) String

func (x *UpdateRecordingRequest) String() string

type UpdateUploadRequest

type UpdateUploadRequest struct {
	Upload     *Upload                `protobuf:"bytes,1,opt,name=upload,proto3" json:"upload,omitempty"`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateUploadRequest) Descriptor deprecated

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

Deprecated: Use UpdateUploadRequest.ProtoReflect.Descriptor instead.

func (*UpdateUploadRequest) GetUpdateMask

func (x *UpdateUploadRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateUploadRequest) GetUpload

func (x *UpdateUploadRequest) GetUpload() *Upload

func (*UpdateUploadRequest) ProtoMessage

func (*UpdateUploadRequest) ProtoMessage()

func (*UpdateUploadRequest) ProtoReflect

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

func (*UpdateUploadRequest) Reset

func (x *UpdateUploadRequest) Reset()

func (*UpdateUploadRequest) String

func (x *UpdateUploadRequest) String() string

type Upload

type Upload struct {
	Name   string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Offset int64  `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"` // current write offset in bytes
	Length int64  `protobuf:"varint,3,opt,name=length,proto3" json:"length,omitempty"` // full upload size in bytes, or 0 if indeterminate
	// Whether the upload has completed. Writing true finalizes the upload,
	// turning it immutable and triggering the distribution pipeline.
	Done       bool                   `protobuf:"varint,4,opt,name=done,proto3" json:"done,omitempty"`
	Sha256     []byte                 `protobuf:"bytes,5,opt,name=sha256,proto3" json:"sha256,omitempty"`
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` // read-only
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"` // read-only
	// contains filtered or unexported fields
}

func (*Upload) Descriptor deprecated

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

Deprecated: Use Upload.ProtoReflect.Descriptor instead.

func (*Upload) GetCreateTime

func (x *Upload) GetCreateTime() *timestamppb.Timestamp

func (*Upload) GetDone

func (x *Upload) GetDone() bool

func (*Upload) GetLength

func (x *Upload) GetLength() int64

func (*Upload) GetName

func (x *Upload) GetName() string

func (*Upload) GetOffset

func (x *Upload) GetOffset() int64

func (*Upload) GetSha256

func (x *Upload) GetSha256() []byte

func (*Upload) GetUpdateTime

func (x *Upload) GetUpdateTime() *timestamppb.Timestamp

func (*Upload) ProtoMessage

func (*Upload) ProtoMessage()

func (*Upload) ProtoReflect

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

func (*Upload) Reset

func (x *Upload) Reset()

func (*Upload) String

func (x *Upload) String() string

type UploadsClient

type UploadsClient interface {
	// GetUpload returns the upload state identified by name.
	//
	// Errors:
	// NOT_FOUND: no such upload
	GetUpload(ctx context.Context, in *GetUploadRequest, opts ...grpc.CallOption) (*Upload, error)
	// CreateUpload attaches an upload state to the recording specified by parent.
	CreateUpload(ctx context.Context, in *CreateUploadRequest, opts ...grpc.CallOption) (*Upload, error)
	// UpdateUpload updates those fields of the upload state specified by
	// update_mask.
	//
	// Writing true into done causes the upload to be finalized. If the
	// sha256 field is written simultaneously, it is compared against the
	// SHA-256 digest of the written upload data.
	//
	// Errors:
	// INVALID_ARGUMENT: update_mask is invalid or specifies immutable
	// field
	// NOT_FOUND: no such upload state
	// OUT_OF_RANGE: atttempt to set total length greater than current write
	// offset
	UpdateUpload(ctx context.Context, in *UpdateUploadRequest, opts ...grpc.CallOption) (*Upload, error)
	// DeleteUpload ...
	DeleteUpload(ctx context.Context, in *DeleteUploadRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// ListUploads ...
	ListUploads(ctx context.Context, in *ListUploadsRequest, opts ...grpc.CallOption) (*ListUploadsResponse, error)
	// Write implements an initial, super-simple, method for writing the
	// actual recording data.
	Write(ctx context.Context, in *WriteRequest, opts ...grpc.CallOption) (*WriteResponse, error)
	// Like Write but client-side streaming
	StreamingWrite(ctx context.Context, opts ...grpc.CallOption) (Uploads_StreamingWriteClient, error)
}

UploadsClient is the client API for Uploads service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewUploadsClient

func NewUploadsClient(cc grpc.ClientConnInterface) UploadsClient

type UploadsServer

type UploadsServer interface {
	// GetUpload returns the upload state identified by name.
	//
	// Errors:
	// NOT_FOUND: no such upload
	GetUpload(context.Context, *GetUploadRequest) (*Upload, error)
	// CreateUpload attaches an upload state to the recording specified by parent.
	CreateUpload(context.Context, *CreateUploadRequest) (*Upload, error)
	// UpdateUpload updates those fields of the upload state specified by
	// update_mask.
	//
	// Writing true into done causes the upload to be finalized. If the
	// sha256 field is written simultaneously, it is compared against the
	// SHA-256 digest of the written upload data.
	//
	// Errors:
	// INVALID_ARGUMENT: update_mask is invalid or specifies immutable
	// field
	// NOT_FOUND: no such upload state
	// OUT_OF_RANGE: atttempt to set total length greater than current write
	// offset
	UpdateUpload(context.Context, *UpdateUploadRequest) (*Upload, error)
	// DeleteUpload ...
	DeleteUpload(context.Context, *DeleteUploadRequest) (*emptypb.Empty, error)
	// ListUploads ...
	ListUploads(context.Context, *ListUploadsRequest) (*ListUploadsResponse, error)
	// Write implements an initial, super-simple, method for writing the
	// actual recording data.
	Write(context.Context, *WriteRequest) (*WriteResponse, error)
	// Like Write but client-side streaming
	StreamingWrite(Uploads_StreamingWriteServer) error
	// contains filtered or unexported methods
}

UploadsServer is the server API for Uploads service. All implementations must embed UnimplementedUploadsServer for forward compatibility

type Uploads_StreamingWriteClient

type Uploads_StreamingWriteClient interface {
	Send(*WriteRequest) error
	CloseAndRecv() (*WriteResponse, error)
	grpc.ClientStream
}

type Uploads_StreamingWriteServer

type Uploads_StreamingWriteServer interface {
	SendAndClose(*WriteResponse) error
	Recv() (*WriteRequest, error)
	grpc.ServerStream
}

type WriteRequest

type WriteRequest struct {
	Name    string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Offset  int64  `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"`
	Content []byte `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

func (*WriteRequest) Descriptor deprecated

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

Deprecated: Use WriteRequest.ProtoReflect.Descriptor instead.

func (*WriteRequest) GetContent

func (x *WriteRequest) GetContent() []byte

func (*WriteRequest) GetName

func (x *WriteRequest) GetName() string

func (*WriteRequest) GetOffset

func (x *WriteRequest) GetOffset() int64

func (*WriteRequest) ProtoMessage

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) ProtoReflect

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

func (*WriteRequest) Reset

func (x *WriteRequest) Reset()

func (*WriteRequest) String

func (x *WriteRequest) String() string

type WriteResponse

type WriteResponse struct {
	NewOffset int64 `protobuf:"varint,1,opt,name=new_offset,json=newOffset,proto3" json:"new_offset,omitempty"`
	// contains filtered or unexported fields
}

func (*WriteResponse) Descriptor deprecated

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

Deprecated: Use WriteResponse.ProtoReflect.Descriptor instead.

func (*WriteResponse) GetNewOffset

func (x *WriteResponse) GetNewOffset() int64

func (*WriteResponse) ProtoMessage

func (*WriteResponse) ProtoMessage()

func (*WriteResponse) ProtoReflect

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

func (*WriteResponse) Reset

func (x *WriteResponse) Reset()

func (*WriteResponse) String

func (x *WriteResponse) String() string

Notes

Bugs

  • do we really want to expose the BBB recording states here?

  • maybe some kind of filter expression?

  • allow caller to specify parent collection and think whether we need more than a flat recordings namespace.

  • allow caller to specify parent collection and think whether we need more than a flat recordings namespace.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL