Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterSrecServer(s grpc.ServiceRegistrar, srv SrecServer)
- type DeleteScreenRecordingRequest
- func (*DeleteScreenRecordingRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteScreenRecordingRequest) GetSessionId() int64
- func (*DeleteScreenRecordingRequest) ProtoMessage()
- func (x *DeleteScreenRecordingRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteScreenRecordingRequest) Reset()
- func (x *DeleteScreenRecordingRequest) String() string
- type DeleteScreenRecordingResponse
- func (*DeleteScreenRecordingResponse) Descriptor() ([]byte, []int)deprecated
- func (*DeleteScreenRecordingResponse) ProtoMessage()
- func (x *DeleteScreenRecordingResponse) ProtoReflect() protoreflect.Message
- func (x *DeleteScreenRecordingResponse) Reset()
- func (x *DeleteScreenRecordingResponse) String() string
- type GetScreenRecordingURLRequest
- func (*GetScreenRecordingURLRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetScreenRecordingURLRequest) GetSessionId() int64
- func (*GetScreenRecordingURLRequest) ProtoMessage()
- func (x *GetScreenRecordingURLRequest) ProtoReflect() protoreflect.Message
- func (x *GetScreenRecordingURLRequest) Reset()
- func (x *GetScreenRecordingURLRequest) String() string
- type GetScreenRecordingURLResponse
- func (*GetScreenRecordingURLResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetScreenRecordingURLResponse) GetUrl() string
- func (*GetScreenRecordingURLResponse) ProtoMessage()
- func (x *GetScreenRecordingURLResponse) ProtoReflect() protoreflect.Message
- func (x *GetScreenRecordingURLResponse) Reset()
- func (x *GetScreenRecordingURLResponse) String() string
- type ListScreenRecordingsRequest
- func (*ListScreenRecordingsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListScreenRecordingsRequest) GetPageSize() uint32
- func (x *ListScreenRecordingsRequest) GetPageToken() string
- func (*ListScreenRecordingsRequest) ProtoMessage()
- func (x *ListScreenRecordingsRequest) ProtoReflect() protoreflect.Message
- func (x *ListScreenRecordingsRequest) Reset()
- func (x *ListScreenRecordingsRequest) String() string
- type ListScreenRecordingsResponse
- func (*ListScreenRecordingsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListScreenRecordingsResponse) GetNextPageToken() string
- func (x *ListScreenRecordingsResponse) GetRecordings() []*ScreenRecording
- func (*ListScreenRecordingsResponse) ProtoMessage()
- func (x *ListScreenRecordingsResponse) ProtoReflect() protoreflect.Message
- func (x *ListScreenRecordingsResponse) Reset()
- func (x *ListScreenRecordingsResponse) String() string
- type ScreenRecording
- func (*ScreenRecording) Descriptor() ([]byte, []int)deprecated
- func (x *ScreenRecording) GetAgentFirstName() string
- func (x *ScreenRecording) GetAgentLastName() string
- func (x *ScreenRecording) GetAudioBytes() int64
- func (x *ScreenRecording) GetAudioTime() uint32
- func (x *ScreenRecording) GetSessionId() int64
- func (x *ScreenRecording) GetStartTime() *timestamppb.Timestamp
- func (*ScreenRecording) ProtoMessage()
- func (x *ScreenRecording) ProtoReflect() protoreflect.Message
- func (x *ScreenRecording) Reset()
- func (x *ScreenRecording) String() string
- type SrecClient
- type SrecServer
- type UnimplementedSrecServer
- func (UnimplementedSrecServer) DeleteScreenRecording(context.Context, *DeleteScreenRecordingRequest) (*DeleteScreenRecordingResponse, error)
- func (UnimplementedSrecServer) GetScreenRecordingURL(context.Context, *GetScreenRecordingURLRequest) (*GetScreenRecordingURLResponse, error)
- func (UnimplementedSrecServer) ListScreenRecordings(context.Context, *ListScreenRecordingsRequest) (*ListScreenRecordingsResponse, error)
- type UnsafeSrecServer
Constants ¶
const ( Srec_ListScreenRecordings_FullMethodName = "/api.v1alpha1.srec.Srec/ListScreenRecordings" Srec_GetScreenRecordingURL_FullMethodName = "/api.v1alpha1.srec.Srec/GetScreenRecordingURL" Srec_DeleteScreenRecording_FullMethodName = "/api.v1alpha1.srec.Srec/DeleteScreenRecording" )
Variables ¶
var File_api_v1alpha1_srec_service_proto protoreflect.FileDescriptor
var Srec_ServiceDesc = grpc.ServiceDesc{ ServiceName: "api.v1alpha1.srec.Srec", HandlerType: (*SrecServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ListScreenRecordings", Handler: _Srec_ListScreenRecordings_Handler, }, { MethodName: "GetScreenRecordingURL", Handler: _Srec_GetScreenRecordingURL_Handler, }, { MethodName: "DeleteScreenRecording", Handler: _Srec_DeleteScreenRecording_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "api/v1alpha1/srec/service.proto", }
Srec_ServiceDesc is the grpc.ServiceDesc for Srec service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSrecServer ¶
func RegisterSrecServer(s grpc.ServiceRegistrar, srv SrecServer)
Types ¶
type DeleteScreenRecordingRequest ¶
type DeleteScreenRecordingRequest struct {
// Required. The unique id of the screen recording to be deleted.
SessionId int64 `protobuf:"varint,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
// contains filtered or unexported fields
}
DeleteScreenRecordingRequest is a request for deleting a screen recording.
func (*DeleteScreenRecordingRequest) Descriptor
deprecated
func (*DeleteScreenRecordingRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteScreenRecordingRequest.ProtoReflect.Descriptor instead.
func (*DeleteScreenRecordingRequest) GetSessionId ¶
func (x *DeleteScreenRecordingRequest) GetSessionId() int64
func (*DeleteScreenRecordingRequest) ProtoMessage ¶
func (*DeleteScreenRecordingRequest) ProtoMessage()
func (*DeleteScreenRecordingRequest) ProtoReflect ¶
func (x *DeleteScreenRecordingRequest) ProtoReflect() protoreflect.Message
func (*DeleteScreenRecordingRequest) Reset ¶
func (x *DeleteScreenRecordingRequest) Reset()
func (*DeleteScreenRecordingRequest) String ¶
func (x *DeleteScreenRecordingRequest) String() string
type DeleteScreenRecordingResponse ¶
type DeleteScreenRecordingResponse struct {
// contains filtered or unexported fields
}
DeleteScreenRecordingResponse is a response for deleting a screen recording.
func (*DeleteScreenRecordingResponse) Descriptor
deprecated
func (*DeleteScreenRecordingResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteScreenRecordingResponse.ProtoReflect.Descriptor instead.
func (*DeleteScreenRecordingResponse) ProtoMessage ¶
func (*DeleteScreenRecordingResponse) ProtoMessage()
func (*DeleteScreenRecordingResponse) ProtoReflect ¶
func (x *DeleteScreenRecordingResponse) ProtoReflect() protoreflect.Message
func (*DeleteScreenRecordingResponse) Reset ¶
func (x *DeleteScreenRecordingResponse) Reset()
func (*DeleteScreenRecordingResponse) String ¶
func (x *DeleteScreenRecordingResponse) String() string
type GetScreenRecordingURLRequest ¶
type GetScreenRecordingURLRequest struct {
// Required. The session id of this screen recording. Must be non empty.
SessionId int64 `protobuf:"varint,2,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
// contains filtered or unexported fields
}
GetScreenRecordingURLRequest is a request for getting a screen recording url.
func (*GetScreenRecordingURLRequest) Descriptor
deprecated
func (*GetScreenRecordingURLRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetScreenRecordingURLRequest.ProtoReflect.Descriptor instead.
func (*GetScreenRecordingURLRequest) GetSessionId ¶
func (x *GetScreenRecordingURLRequest) GetSessionId() int64
func (*GetScreenRecordingURLRequest) ProtoMessage ¶
func (*GetScreenRecordingURLRequest) ProtoMessage()
func (*GetScreenRecordingURLRequest) ProtoReflect ¶
func (x *GetScreenRecordingURLRequest) ProtoReflect() protoreflect.Message
func (*GetScreenRecordingURLRequest) Reset ¶
func (x *GetScreenRecordingURLRequest) Reset()
func (*GetScreenRecordingURLRequest) String ¶
func (x *GetScreenRecordingURLRequest) String() string
type GetScreenRecordingURLResponse ¶
type GetScreenRecordingURLResponse struct {
// The url for the screen recording.
Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
// contains filtered or unexported fields
}
GetScreenRecordingURLResponse is a response for getting a screen recording url.
func (*GetScreenRecordingURLResponse) Descriptor
deprecated
func (*GetScreenRecordingURLResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetScreenRecordingURLResponse.ProtoReflect.Descriptor instead.
func (*GetScreenRecordingURLResponse) GetUrl ¶
func (x *GetScreenRecordingURLResponse) GetUrl() string
func (*GetScreenRecordingURLResponse) ProtoMessage ¶
func (*GetScreenRecordingURLResponse) ProtoMessage()
func (*GetScreenRecordingURLResponse) ProtoReflect ¶
func (x *GetScreenRecordingURLResponse) ProtoReflect() protoreflect.Message
func (*GetScreenRecordingURLResponse) Reset ¶
func (x *GetScreenRecordingURLResponse) Reset()
func (*GetScreenRecordingURLResponse) String ¶
func (x *GetScreenRecordingURLResponse) String() string
type ListScreenRecordingsRequest ¶
type ListScreenRecordingsRequest struct {
// Optional. The number of screen recordings to include in a single response. When not
// provided this defaults to 100.
PageSize uint32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The next_page_token returned from a previous List request, if any.
// When provided all other request fields are ignored.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
ListScreenRecordingsRequest is a request for listing screen recordings.
func (*ListScreenRecordingsRequest) Descriptor
deprecated
func (*ListScreenRecordingsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListScreenRecordingsRequest.ProtoReflect.Descriptor instead.
func (*ListScreenRecordingsRequest) GetPageSize ¶
func (x *ListScreenRecordingsRequest) GetPageSize() uint32
func (*ListScreenRecordingsRequest) GetPageToken ¶
func (x *ListScreenRecordingsRequest) GetPageToken() string
func (*ListScreenRecordingsRequest) ProtoMessage ¶
func (*ListScreenRecordingsRequest) ProtoMessage()
func (*ListScreenRecordingsRequest) ProtoReflect ¶
func (x *ListScreenRecordingsRequest) ProtoReflect() protoreflect.Message
func (*ListScreenRecordingsRequest) Reset ¶
func (x *ListScreenRecordingsRequest) Reset()
func (*ListScreenRecordingsRequest) String ¶
func (x *ListScreenRecordingsRequest) String() string
type ListScreenRecordingsResponse ¶
type ListScreenRecordingsResponse struct {
// Token to retrieve the next page of screen recordings, or empty if there are no
// more screen recordings in the list.
NextPageToken string `protobuf:"bytes,1,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// List of screen recordings which contains at most one request page_size.
Recordings []*ScreenRecording `protobuf:"bytes,2,rep,name=recordings,proto3" json:"recordings,omitempty"`
// contains filtered or unexported fields
}
ListScreenRecordingsResponse is a response for listing screen recordings.
func (*ListScreenRecordingsResponse) Descriptor
deprecated
func (*ListScreenRecordingsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListScreenRecordingsResponse.ProtoReflect.Descriptor instead.
func (*ListScreenRecordingsResponse) GetNextPageToken ¶
func (x *ListScreenRecordingsResponse) GetNextPageToken() string
func (*ListScreenRecordingsResponse) GetRecordings ¶
func (x *ListScreenRecordingsResponse) GetRecordings() []*ScreenRecording
func (*ListScreenRecordingsResponse) ProtoMessage ¶
func (*ListScreenRecordingsResponse) ProtoMessage()
func (*ListScreenRecordingsResponse) ProtoReflect ¶
func (x *ListScreenRecordingsResponse) ProtoReflect() protoreflect.Message
func (*ListScreenRecordingsResponse) Reset ¶
func (x *ListScreenRecordingsResponse) Reset()
func (*ListScreenRecordingsResponse) String ¶
func (x *ListScreenRecordingsResponse) String() string
type ScreenRecording ¶
type ScreenRecording struct {
// Output only. The unique id of this screen recording.
SessionId int64 `protobuf:"varint,2,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
// Required. The agent first name.
AgentFirstName string `protobuf:"bytes,3,opt,name=agent_first_name,json=agentFirstName,proto3" json:"agent_first_name,omitempty"`
// Required. The agent last name.
AgentLastName string `protobuf:"bytes,4,opt,name=agent_last_name,json=agentLastName,proto3" json:"agent_last_name,omitempty"`
// Required. Start time is the start time of the screen recording.
StartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Required. Audio time in milliseconds.
AudioTime uint32 `protobuf:"varint,6,opt,name=audio_time,json=audioTime,proto3" json:"audio_time,omitempty"`
// Required. Audio bytes of the screen recording.
AudioBytes int64 `protobuf:"varint,7,opt,name=audio_bytes,json=audioBytes,proto3" json:"audio_bytes,omitempty"`
// contains filtered or unexported fields
}
ScreenRecording is a resource in the SREC API.
func (*ScreenRecording) Descriptor
deprecated
func (*ScreenRecording) Descriptor() ([]byte, []int)
Deprecated: Use ScreenRecording.ProtoReflect.Descriptor instead.
func (*ScreenRecording) GetAgentFirstName ¶
func (x *ScreenRecording) GetAgentFirstName() string
func (*ScreenRecording) GetAgentLastName ¶
func (x *ScreenRecording) GetAgentLastName() string
func (*ScreenRecording) GetAudioBytes ¶
func (x *ScreenRecording) GetAudioBytes() int64
func (*ScreenRecording) GetAudioTime ¶
func (x *ScreenRecording) GetAudioTime() uint32
func (*ScreenRecording) GetSessionId ¶
func (x *ScreenRecording) GetSessionId() int64
func (*ScreenRecording) GetStartTime ¶
func (x *ScreenRecording) GetStartTime() *timestamppb.Timestamp
func (*ScreenRecording) ProtoMessage ¶
func (*ScreenRecording) ProtoMessage()
func (*ScreenRecording) ProtoReflect ¶
func (x *ScreenRecording) ProtoReflect() protoreflect.Message
func (*ScreenRecording) Reset ¶
func (x *ScreenRecording) Reset()
func (*ScreenRecording) String ¶
func (x *ScreenRecording) String() string
type SrecClient ¶
type SrecClient interface {
// ListScreenRecordings returns screen recordings.
ListScreenRecordings(ctx context.Context, in *ListScreenRecordingsRequest, opts ...grpc.CallOption) (*ListScreenRecordingsResponse, error)
// GetScreenRecordingURL returns the screen recording url.
GetScreenRecordingURL(ctx context.Context, in *GetScreenRecordingURLRequest, opts ...grpc.CallOption) (*GetScreenRecordingURLResponse, error)
// DeleteScreenRecording deletes a screen recording.
DeleteScreenRecording(ctx context.Context, in *DeleteScreenRecordingRequest, opts ...grpc.CallOption) (*DeleteScreenRecordingResponse, error)
}
SrecClient is the client API for Srec 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 NewSrecClient ¶
func NewSrecClient(cc grpc.ClientConnInterface) SrecClient
type SrecServer ¶
type SrecServer interface {
// ListScreenRecordings returns screen recordings.
ListScreenRecordings(context.Context, *ListScreenRecordingsRequest) (*ListScreenRecordingsResponse, error)
// GetScreenRecordingURL returns the screen recording url.
GetScreenRecordingURL(context.Context, *GetScreenRecordingURLRequest) (*GetScreenRecordingURLResponse, error)
// DeleteScreenRecording deletes a screen recording.
DeleteScreenRecording(context.Context, *DeleteScreenRecordingRequest) (*DeleteScreenRecordingResponse, error)
// contains filtered or unexported methods
}
SrecServer is the server API for Srec service. All implementations must embed UnimplementedSrecServer for forward compatibility.
type UnimplementedSrecServer ¶
type UnimplementedSrecServer struct{}
UnimplementedSrecServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedSrecServer) DeleteScreenRecording ¶
func (UnimplementedSrecServer) DeleteScreenRecording(context.Context, *DeleteScreenRecordingRequest) (*DeleteScreenRecordingResponse, error)
func (UnimplementedSrecServer) GetScreenRecordingURL ¶
func (UnimplementedSrecServer) GetScreenRecordingURL(context.Context, *GetScreenRecordingURLRequest) (*GetScreenRecordingURLResponse, error)
func (UnimplementedSrecServer) ListScreenRecordings ¶
func (UnimplementedSrecServer) ListScreenRecordings(context.Context, *ListScreenRecordingsRequest) (*ListScreenRecordingsResponse, error)
type UnsafeSrecServer ¶
type UnsafeSrecServer interface {
// contains filtered or unexported methods
}
UnsafeSrecServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SrecServer will result in compilation errors.