Ydb_Topic_V1

package
v0.0.0-...-8dd88c8 Latest Latest
Warning

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

Go to latest
Published: Mar 9, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	TopicService_StreamWrite_FullMethodName                = "/Ydb.Topic.V1.TopicService/StreamWrite"
	TopicService_StreamRead_FullMethodName                 = "/Ydb.Topic.V1.TopicService/StreamRead"
	TopicService_CommitOffset_FullMethodName               = "/Ydb.Topic.V1.TopicService/CommitOffset"
	TopicService_UpdateOffsetsInTransaction_FullMethodName = "/Ydb.Topic.V1.TopicService/UpdateOffsetsInTransaction"
	TopicService_CreateTopic_FullMethodName                = "/Ydb.Topic.V1.TopicService/CreateTopic"
	TopicService_DescribeTopic_FullMethodName              = "/Ydb.Topic.V1.TopicService/DescribeTopic"
	TopicService_DescribeConsumer_FullMethodName           = "/Ydb.Topic.V1.TopicService/DescribeConsumer"
	TopicService_AlterTopic_FullMethodName                 = "/Ydb.Topic.V1.TopicService/AlterTopic"
	TopicService_DropTopic_FullMethodName                  = "/Ydb.Topic.V1.TopicService/DropTopic"
)

Variables

View Source
var File_ydb_topic_v1_proto protoreflect.FileDescriptor
View Source
var TopicService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "Ydb.Topic.V1.TopicService",
	HandlerType: (*TopicServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CommitOffset",
			Handler:    _TopicService_CommitOffset_Handler,
		},
		{
			MethodName: "UpdateOffsetsInTransaction",
			Handler:    _TopicService_UpdateOffsetsInTransaction_Handler,
		},
		{
			MethodName: "CreateTopic",
			Handler:    _TopicService_CreateTopic_Handler,
		},
		{
			MethodName: "DescribeTopic",
			Handler:    _TopicService_DescribeTopic_Handler,
		},
		{
			MethodName: "DescribeConsumer",
			Handler:    _TopicService_DescribeConsumer_Handler,
		},
		{
			MethodName: "AlterTopic",
			Handler:    _TopicService_AlterTopic_Handler,
		},
		{
			MethodName: "DropTopic",
			Handler:    _TopicService_DropTopic_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamWrite",
			Handler:       _TopicService_StreamWrite_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "StreamRead",
			Handler:       _TopicService_StreamRead_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "ydb_topic_v1.proto",
}

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

Functions

func RegisterTopicServiceServer

func RegisterTopicServiceServer(s grpc.ServiceRegistrar, srv TopicServiceServer)

Types

type TopicServiceClient

type TopicServiceClient interface {
	// Create Write Session
	// Pipeline example:
	// client                  server
	//
	//	 InitRequest(Topic, MessageGroupID, ...)
	//	---------------->
	//	 InitResponse(Partition, MaxSeqNo, ...)
	//	<----------------
	//	 WriteRequest(data1, seqNo1)
	//	---------------->
	//	 WriteRequest(data2, seqNo2)
	//	---------------->
	//	 WriteResponse(seqNo1, offset1, ...)
	//	<----------------
	//	 WriteRequest(data3, seqNo3)
	//	---------------->
	//	 WriteResponse(seqNo2, offset2, ...)
	//	<----------------
	//	 [something went wrong] (status != SUCCESS, issues not empty)
	//	<----------------
	StreamWrite(ctx context.Context, opts ...grpc.CallOption) (TopicService_StreamWriteClient, error)
	// Create Read Session
	// Pipeline:
	// client                  server
	//
	//	 InitRequest(Topics, ClientId, ...)
	//	---------------->
	//	 InitResponse(SessionId)
	//	<----------------
	//	 ReadRequest
	//	---------------->
	//	 ReadRequest
	//	---------------->
	//	 StartPartitionSessionRequest(Topic1, Partition1, PartitionSessionID1, ...)
	//	<----------------
	//	 StartPartitionSessionRequest(Topic2, Partition2, PartitionSessionID2, ...)
	//	<----------------
	//	 StartPartitionSessionResponse(PartitionSessionID1, ...)
	//	     client must respond with this message to actually start recieving data messages from this partition
	//	---------------->
	//	 StopPartitionSessionRequest(PartitionSessionID1, ...)
	//	<----------------
	//	 StopPartitionSessionResponse(PartitionSessionID1, ...)
	//	     only after this response server will give this parittion to other session.
	//	---------------->
	//	 StartPartitionSessionResponse(PartitionSession2, ...)
	//	---------------->
	//	 ReadResponse(data, ...)
	//	<----------------
	//	 CommitRequest(PartitionCommit1, ...)
	//	---------------->
	//	 CommitResponse(PartitionCommitAck1, ...)
	//	<----------------
	//	 [something went wrong] (status != SUCCESS, issues not empty)
	//	<----------------
	StreamRead(ctx context.Context, opts ...grpc.CallOption) (TopicService_StreamReadClient, error)
	// Single commit offset request.
	CommitOffset(ctx context.Context, in *Ydb_Topic.CommitOffsetRequest, opts ...grpc.CallOption) (*Ydb_Topic.CommitOffsetResponse, error)
	// Add information about offset ranges to the transaction.
	UpdateOffsetsInTransaction(ctx context.Context, in *Ydb_Topic.UpdateOffsetsInTransactionRequest, opts ...grpc.CallOption) (*Ydb_Topic.UpdateOffsetsInTransactionResponse, error)
	// Create topic command.
	CreateTopic(ctx context.Context, in *Ydb_Topic.CreateTopicRequest, opts ...grpc.CallOption) (*Ydb_Topic.CreateTopicResponse, error)
	// Describe topic command.
	DescribeTopic(ctx context.Context, in *Ydb_Topic.DescribeTopicRequest, opts ...grpc.CallOption) (*Ydb_Topic.DescribeTopicResponse, error)
	// Describe topic's consumer command.
	DescribeConsumer(ctx context.Context, in *Ydb_Topic.DescribeConsumerRequest, opts ...grpc.CallOption) (*Ydb_Topic.DescribeConsumerResponse, error)
	// Alter topic command.
	AlterTopic(ctx context.Context, in *Ydb_Topic.AlterTopicRequest, opts ...grpc.CallOption) (*Ydb_Topic.AlterTopicResponse, error)
	// Drop topic command.
	DropTopic(ctx context.Context, in *Ydb_Topic.DropTopicRequest, opts ...grpc.CallOption) (*Ydb_Topic.DropTopicResponse, error)
}

TopicServiceClient is the client API for TopicService 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.

type TopicServiceServer

type TopicServiceServer interface {
	// Create Write Session
	// Pipeline example:
	// client                  server
	//
	//	 InitRequest(Topic, MessageGroupID, ...)
	//	---------------->
	//	 InitResponse(Partition, MaxSeqNo, ...)
	//	<----------------
	//	 WriteRequest(data1, seqNo1)
	//	---------------->
	//	 WriteRequest(data2, seqNo2)
	//	---------------->
	//	 WriteResponse(seqNo1, offset1, ...)
	//	<----------------
	//	 WriteRequest(data3, seqNo3)
	//	---------------->
	//	 WriteResponse(seqNo2, offset2, ...)
	//	<----------------
	//	 [something went wrong] (status != SUCCESS, issues not empty)
	//	<----------------
	StreamWrite(TopicService_StreamWriteServer) error
	// Create Read Session
	// Pipeline:
	// client                  server
	//
	//	 InitRequest(Topics, ClientId, ...)
	//	---------------->
	//	 InitResponse(SessionId)
	//	<----------------
	//	 ReadRequest
	//	---------------->
	//	 ReadRequest
	//	---------------->
	//	 StartPartitionSessionRequest(Topic1, Partition1, PartitionSessionID1, ...)
	//	<----------------
	//	 StartPartitionSessionRequest(Topic2, Partition2, PartitionSessionID2, ...)
	//	<----------------
	//	 StartPartitionSessionResponse(PartitionSessionID1, ...)
	//	     client must respond with this message to actually start recieving data messages from this partition
	//	---------------->
	//	 StopPartitionSessionRequest(PartitionSessionID1, ...)
	//	<----------------
	//	 StopPartitionSessionResponse(PartitionSessionID1, ...)
	//	     only after this response server will give this parittion to other session.
	//	---------------->
	//	 StartPartitionSessionResponse(PartitionSession2, ...)
	//	---------------->
	//	 ReadResponse(data, ...)
	//	<----------------
	//	 CommitRequest(PartitionCommit1, ...)
	//	---------------->
	//	 CommitResponse(PartitionCommitAck1, ...)
	//	<----------------
	//	 [something went wrong] (status != SUCCESS, issues not empty)
	//	<----------------
	StreamRead(TopicService_StreamReadServer) error
	// Single commit offset request.
	CommitOffset(context.Context, *Ydb_Topic.CommitOffsetRequest) (*Ydb_Topic.CommitOffsetResponse, error)
	// Add information about offset ranges to the transaction.
	UpdateOffsetsInTransaction(context.Context, *Ydb_Topic.UpdateOffsetsInTransactionRequest) (*Ydb_Topic.UpdateOffsetsInTransactionResponse, error)
	// Create topic command.
	CreateTopic(context.Context, *Ydb_Topic.CreateTopicRequest) (*Ydb_Topic.CreateTopicResponse, error)
	// Describe topic command.
	DescribeTopic(context.Context, *Ydb_Topic.DescribeTopicRequest) (*Ydb_Topic.DescribeTopicResponse, error)
	// Describe topic's consumer command.
	DescribeConsumer(context.Context, *Ydb_Topic.DescribeConsumerRequest) (*Ydb_Topic.DescribeConsumerResponse, error)
	// Alter topic command.
	AlterTopic(context.Context, *Ydb_Topic.AlterTopicRequest) (*Ydb_Topic.AlterTopicResponse, error)
	// Drop topic command.
	DropTopic(context.Context, *Ydb_Topic.DropTopicRequest) (*Ydb_Topic.DropTopicResponse, error)
	// contains filtered or unexported methods
}

TopicServiceServer is the server API for TopicService service. All implementations must embed UnimplementedTopicServiceServer for forward compatibility

type UnimplementedTopicServiceServer

type UnimplementedTopicServiceServer struct {
}

UnimplementedTopicServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedTopicServiceServer) StreamRead

func (UnimplementedTopicServiceServer) StreamWrite

type UnsafeTopicServiceServer

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

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

Jump to

Keyboard shortcuts

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