admpb

type AddLogStreamRequest struct {
	TopicID github_com_kakao_varlog_pkg_types.TopicID `` /* 134-byte string literal not displayed */
	// TODO: nullable = false
	Replicas []*varlogpb.ReplicaDescriptor `protobuf:"bytes,2,rep,name=replicas,proto3" json:"replicas,omitempty"`
}

type AddLogStreamResponse struct {
	LogStream *varlogpb.LogStreamDescriptor `protobuf:"bytes,1,opt,name=log_stream,json=logStream,proto3" json:"log_stream,omitempty"`
}

type AddMRPeerRequest struct {
	RaftURL string `protobuf:"bytes,1,opt,name=raft_url,json=raftUrl,proto3" json:"raft_url,omitempty"`
	RPCAddr string `protobuf:"bytes,2,opt,name=rpc_addr,json=rpcAddr,proto3" json:"rpc_addr,omitempty"`
}

type AddMRPeerResponse struct {
	NodeID github_com_kakao_varlog_pkg_types.NodeID `` /* 129-byte string literal not displayed */
}

type AddMetadataRepositoryNodeRequest struct {
	RaftURL string `protobuf:"bytes,1,opt,name=raft_url,json=raftUrl,proto3" json:"raft_url,omitempty"`
	RPCAddr string `protobuf:"bytes,2,opt,name=rpc_addr,json=rpcAddr,proto3" json:"rpc_addr,omitempty"`
}

type AddMetadataRepositoryNodeResponse struct {
	Node *varlogpb.MetadataRepositoryNode `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
}

type AddStorageNodeRequest struct {
	StorageNode varlogpb.StorageNode `protobuf:"bytes,1,opt,name=storage_node,json=storageNode,proto3" json:"storage_node"`
}

type AddStorageNodeResponse struct {
	StorageNode *StorageNodeMetadata `protobuf:"bytes,1,opt,name=storage_node,json=storageNode,proto3" json:"storageNode"`
}

type AddTopicRequest struct {
}

type AddTopicResponse struct {
	Topic *varlogpb.TopicDescriptor `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic"`
}

type ClusterManagerClient interface {
	// GetStorageNode returns the metadata of the storage node requested.
	// It produces a gRPC NotFound error if the storage node does not exist. If
	// the metadata repository cannot be reachable, it returns a gRPC Unavailable
	// error. In this case, clients can retry with proper backoff to fix it.
	GetStorageNode(ctx context.Context, in *GetStorageNodeRequest, opts ...grpc.CallOption) (*GetStorageNodeResponse, error)
	// ListStorageNodes returns a list of storage nodes.
	// If the metadata repository cannot be reachable, it returns a gRPC
	// Unavailable error. In this case, clients can retry with proper backoff to
	// fix it. If the metadata fetched from the metadata repository is
	// inconsistent, it returns a gRPC Internal error.
	ListStorageNodes(ctx context.Context, in *ListStorageNodesRequest, opts ...grpc.CallOption) (*ListStorageNodesResponse, error)
	// AddStorageNode adds a new storage node to the cluster. It is idempotent;
	// adding an already added storage node is okay.
	// Note that if the admin server cannot refresh the storage node list in the
	// memory, it returns a gRPC Unavailable error. However, the storage node
	// could have been added, so users should call this RPC with the same
	// parameter again.
	AddStorageNode(ctx context.Context, in *AddStorageNodeRequest, opts ...grpc.CallOption) (*AddStorageNodeResponse, error)
	// UnregisterStorageNode unregisters the storage node specified by the
	// argument snid. If users try to unregister an already non-exist node, it
	// returns okay.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - FailedPrecondition: The storage node still has valid log stream replicas.
	UnregisterStorageNode(ctx context.Context, in *UnregisterStorageNodeRequest, opts ...grpc.CallOption) (*UnregisterStorageNodeResponse, error)
	// GetTopic returns the topic specified by the request.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - NotFound: The topic doesn't exist.
	GetTopic(ctx context.Context, in *GetTopicRequest, opts ...grpc.CallOption) (*GetTopicResponse, error)
	// DescribeTopic returns the topic specified by the request.
	// Deprecated: Use GetTopic.
	DescribeTopic(ctx context.Context, in *DescribeTopicRequest, opts ...grpc.CallOption) (*DescribeTopicResponse, error)
	// ListTopics returns a list of topics in the cluster.
	ListTopics(ctx context.Context, in *ListTopicsRequest, opts ...grpc.CallOption) (*ListTopicsResponse, error)
	// AddTopic adds a new topic and returns its metadata.
	// It produces a gRPC Internal error if the metadata rejects the request.
	AddTopic(ctx context.Context, in *AddTopicRequest, opts ...grpc.CallOption) (*AddTopicResponse, error)
	// UnregisterTopic unregisters the topic specified by the argument tpid.
	// It returns a gRPC Unavailable error if the metadata cannot be fetched from
	// the metadata repository.
	// TODO: Its behavior is unclear if the topic has already been removed.
	// FIXME: It overwrites the gRPC errors returned from the metadata repository,
	// even if some may be important.
	UnregisterTopic(ctx context.Context, in *UnregisterTopicRequest, opts ...grpc.CallOption) (*UnregisterTopicResponse, error)
	// GetLogStream returns the metadata of the log stream specified by the
	// arguments tpid and lsid. The metadata is the type stored in the metadata
	// repository.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - NotFound: Either the topic or the log stream does not exist.
	// - Internal: The TopicID in the log stream metadata doesn't match.
	GetLogStream(ctx context.Context, in *GetLogStreamRequest, opts ...grpc.CallOption) (*GetLogStreamResponse, error)
	// ListLogStreams returns all log streams belonging to the topic specified by
	// the argument tpid.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - NotFound: The topic does not exist.
	// - Internal: The TopicID in the log stream metadata doesn't match.
	ListLogStreams(ctx context.Context, in *ListLogStreamsRequest, opts ...grpc.CallOption) (*ListLogStreamsResponse, error)
	// AddLogStream adds a new log stream to the cluster.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - ResourceExhausted: The number of log streams is reached the upper limit.
	// - FailedPrecondition: Replicas information in the request is invalid; for
	// example, the number of log stream replicas in the request does not equal
	// the replication factor, or the storage node for the replica does not exist.
	//
	// TODO: Not all errors are codified.
	AddLogStream(ctx context.Context, in *AddLogStreamRequest, opts ...grpc.CallOption) (*AddLogStreamResponse, error)
	// UpdateLogStream changes the configuration of replicas in a log stream.
	//
	// Its codes are defines as followings:
	// - InvalidArgument: The client tries to swap the same replica.
	// - Unavailable: The cluster metadata cannot be fetched from the metadata
	// repository transiently.
	// - NotFound: The target log stream does not exist.
	// - FailedPrecondition: Either the target log stream is not sealed, the
	// target log stream doesn't have a victim replica, or the target log stream
	// already has both victim and new replica. Note that clients should not retry
	// without any action.
	// - Unknown: Either storage node or metadata repository returns an error.
	//
	// TODO: Moving the data directory within the same node is not supported yet.
	// TODO: We will define codes for errors returned from storage nodes and
	// metadata repository soon.
	UpdateLogStream(ctx context.Context, in *UpdateLogStreamRequest, opts ...grpc.CallOption) (*UpdateLogStreamResponse, error)
	// UnregisterLogStream unregisters the log stream specified by the arguments
	// tpid and lsid.
	// TODO: It is not tested.
	UnregisterLogStream(ctx context.Context, in *UnregisterLogStreamRequest, opts ...grpc.CallOption) (*UnregisterLogStreamResponse, error)
	// RemoveLogStreamReplica removes the log stream replica specified by the
	// arguments snid, tpid, and lsid.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - FailedPrecondition: The log stream of the log stream replica can't be
	// removable, e.g., clients still can append logs to the log stream.
	RemoveLogStreamReplica(ctx context.Context, in *RemoveLogStreamReplicaRequest, opts ...grpc.CallOption) (*RemoveLogStreamReplicaResponse, error)
	Seal(ctx context.Context, in *SealRequest, opts ...grpc.CallOption) (*SealResponse, error)
	Unseal(ctx context.Context, in *UnsealRequest, opts ...grpc.CallOption) (*UnsealResponse, error)
	Sync(ctx context.Context, in *SyncRequest, opts ...grpc.CallOption) (*SyncResponse, error)
	Trim(ctx context.Context, in *TrimRequest, opts ...grpc.CallOption) (*TrimResponse, error)
	GetMetadataRepositoryNode(ctx context.Context, in *GetMetadataRepositoryNodeRequest, opts ...grpc.CallOption) (*GetMetadataRepositoryNodeResponse, error)
	ListMetadataRepositoryNodes(ctx context.Context, in *ListMetadataRepositoryNodesRequest, opts ...grpc.CallOption) (*ListMetadataRepositoryNodesResponse, error)
	GetMRMembers(ctx context.Context, in *types.Empty, opts ...grpc.CallOption) (*GetMRMembersResponse, error)
	AddMetadataRepositoryNode(ctx context.Context, in *AddMetadataRepositoryNodeRequest, opts ...grpc.CallOption) (*AddMetadataRepositoryNodeResponse, error)
	AddMRPeer(ctx context.Context, in *AddMRPeerRequest, opts ...grpc.CallOption) (*AddMRPeerResponse, error)
	DeleteMetadataRepositoryNode(ctx context.Context, in *DeleteMetadataRepositoryNodeRequest, opts ...grpc.CallOption) (*DeleteMetadataRepositoryNodeResponse, error)
	RemoveMRPeer(ctx context.Context, in *RemoveMRPeerRequest, opts ...grpc.CallOption) (*RemoveMRPeerResponse, error)
}

type ClusterManagerServer interface {
	// GetStorageNode returns the metadata of the storage node requested.
	// It produces a gRPC NotFound error if the storage node does not exist. If
	// the metadata repository cannot be reachable, it returns a gRPC Unavailable
	// error. In this case, clients can retry with proper backoff to fix it.
	GetStorageNode(context.Context, *GetStorageNodeRequest) (*GetStorageNodeResponse, error)
	// ListStorageNodes returns a list of storage nodes.
	// If the metadata repository cannot be reachable, it returns a gRPC
	// Unavailable error. In this case, clients can retry with proper backoff to
	// fix it. If the metadata fetched from the metadata repository is
	// inconsistent, it returns a gRPC Internal error.
	ListStorageNodes(context.Context, *ListStorageNodesRequest) (*ListStorageNodesResponse, error)
	// AddStorageNode adds a new storage node to the cluster. It is idempotent;
	// adding an already added storage node is okay.
	// Note that if the admin server cannot refresh the storage node list in the
	// memory, it returns a gRPC Unavailable error. However, the storage node
	// could have been added, so users should call this RPC with the same
	// parameter again.
	AddStorageNode(context.Context, *AddStorageNodeRequest) (*AddStorageNodeResponse, error)
	// UnregisterStorageNode unregisters the storage node specified by the
	// argument snid. If users try to unregister an already non-exist node, it
	// returns okay.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - FailedPrecondition: The storage node still has valid log stream replicas.
	UnregisterStorageNode(context.Context, *UnregisterStorageNodeRequest) (*UnregisterStorageNodeResponse, error)
	// GetTopic returns the topic specified by the request.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - NotFound: The topic doesn't exist.
	GetTopic(context.Context, *GetTopicRequest) (*GetTopicResponse, error)
	// DescribeTopic returns the topic specified by the request.
	// Deprecated: Use GetTopic.
	DescribeTopic(context.Context, *DescribeTopicRequest) (*DescribeTopicResponse, error)
	// ListTopics returns a list of topics in the cluster.
	ListTopics(context.Context, *ListTopicsRequest) (*ListTopicsResponse, error)
	// AddTopic adds a new topic and returns its metadata.
	// It produces a gRPC Internal error if the metadata rejects the request.
	AddTopic(context.Context, *AddTopicRequest) (*AddTopicResponse, error)
	// UnregisterTopic unregisters the topic specified by the argument tpid.
	// It returns a gRPC Unavailable error if the metadata cannot be fetched from
	// the metadata repository.
	// TODO: Its behavior is unclear if the topic has already been removed.
	// FIXME: It overwrites the gRPC errors returned from the metadata repository,
	// even if some may be important.
	UnregisterTopic(context.Context, *UnregisterTopicRequest) (*UnregisterTopicResponse, error)
	// GetLogStream returns the metadata of the log stream specified by the
	// arguments tpid and lsid. The metadata is the type stored in the metadata
	// repository.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - NotFound: Either the topic or the log stream does not exist.
	// - Internal: The TopicID in the log stream metadata doesn't match.
	GetLogStream(context.Context, *GetLogStreamRequest) (*GetLogStreamResponse, error)
	// ListLogStreams returns all log streams belonging to the topic specified by
	// the argument tpid.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - NotFound: The topic does not exist.
	// - Internal: The TopicID in the log stream metadata doesn't match.
	ListLogStreams(context.Context, *ListLogStreamsRequest) (*ListLogStreamsResponse, error)
	// AddLogStream adds a new log stream to the cluster.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - ResourceExhausted: The number of log streams is reached the upper limit.
	// - FailedPrecondition: Replicas information in the request is invalid; for
	// example, the number of log stream replicas in the request does not equal
	// the replication factor, or the storage node for the replica does not exist.
	//
	// TODO: Not all errors are codified.
	AddLogStream(context.Context, *AddLogStreamRequest) (*AddLogStreamResponse, error)
	// UpdateLogStream changes the configuration of replicas in a log stream.
	//
	// Its codes are defines as followings:
	// - InvalidArgument: The client tries to swap the same replica.
	// - Unavailable: The cluster metadata cannot be fetched from the metadata
	// repository transiently.
	// - NotFound: The target log stream does not exist.
	// - FailedPrecondition: Either the target log stream is not sealed, the
	// target log stream doesn't have a victim replica, or the target log stream
	// already has both victim and new replica. Note that clients should not retry
	// without any action.
	// - Unknown: Either storage node or metadata repository returns an error.
	//
	// TODO: Moving the data directory within the same node is not supported yet.
	// TODO: We will define codes for errors returned from storage nodes and
	// metadata repository soon.
	UpdateLogStream(context.Context, *UpdateLogStreamRequest) (*UpdateLogStreamResponse, error)
	// UnregisterLogStream unregisters the log stream specified by the arguments
	// tpid and lsid.
	// TODO: It is not tested.
	UnregisterLogStream(context.Context, *UnregisterLogStreamRequest) (*UnregisterLogStreamResponse, error)
	// RemoveLogStreamReplica removes the log stream replica specified by the
	// arguments snid, tpid, and lsid.
	//
	// It returns the following gRPC errors:
	// - Unavailable: The metadata cannot be fetched from the metadata repository.
	// - FailedPrecondition: The log stream of the log stream replica can't be
	// removable, e.g., clients still can append logs to the log stream.
	RemoveLogStreamReplica(context.Context, *RemoveLogStreamReplicaRequest) (*RemoveLogStreamReplicaResponse, error)
	Seal(context.Context, *SealRequest) (*SealResponse, error)
	Unseal(context.Context, *UnsealRequest) (*UnsealResponse, error)
	Sync(context.Context, *SyncRequest) (*SyncResponse, error)
	Trim(context.Context, *TrimRequest) (*TrimResponse, error)
	GetMetadataRepositoryNode(context.Context, *GetMetadataRepositoryNodeRequest) (*GetMetadataRepositoryNodeResponse, error)
	ListMetadataRepositoryNodes(context.Context, *ListMetadataRepositoryNodesRequest) (*ListMetadataRepositoryNodesResponse, error)
	GetMRMembers(context.Context, *types.Empty) (*GetMRMembersResponse, error)
	AddMetadataRepositoryNode(context.Context, *AddMetadataRepositoryNodeRequest) (*AddMetadataRepositoryNodeResponse, error)
	AddMRPeer(context.Context, *AddMRPeerRequest) (*AddMRPeerResponse, error)
	DeleteMetadataRepositoryNode(context.Context, *DeleteMetadataRepositoryNodeRequest) (*DeleteMetadataRepositoryNodeResponse, error)
	RemoveMRPeer(context.Context, *RemoveMRPeerRequest) (*RemoveMRPeerResponse, error)
}

type DeleteMetadataRepositoryNodeRequest struct {
	NodeID github_com_kakao_varlog_pkg_types.NodeID `protobuf:"varint,1,opt,name=node_id,json=nodeId,proto3,casttype=github.com/kakao/varlog/pkg/types.NodeID" json:"nodeId"`
}

type DeleteMetadataRepositoryNodeResponse struct {
}

type DescribeTopicRequest struct {
	TopicID github_com_kakao_varlog_pkg_types.TopicID `` /* 134-byte string literal not displayed */
}

type DescribeTopicResponse struct {
	Topic      varlogpb.TopicDescriptor       `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic"`
	LogStreams []varlogpb.LogStreamDescriptor `protobuf:"bytes,2,rep,name=log_streams,json=logStreams,proto3" json:"log_streams"`
}

type GetLogStreamRequest struct {
	TopicID     github_com_kakao_varlog_pkg_types.TopicID     `` /* 134-byte string literal not displayed */
	LogStreamID github_com_kakao_varlog_pkg_types.LogStreamID `` /* 152-byte string literal not displayed */
}

type GetLogStreamResponse struct {
	LogStream *varlogpb.LogStreamDescriptor `protobuf:"bytes,1,opt,name=log_stream,json=logStream,proto3" json:"logStream"`
}

type GetMRMembersResponse struct {
	Leader            github_com_kakao_varlog_pkg_types.NodeID            `protobuf:"varint,1,opt,name=leader,proto3,casttype=github.com/kakao/varlog/pkg/types.NodeID" json:"leader,omitempty"`
	ReplicationFactor int32                                               `protobuf:"varint,2,opt,name=replication_factor,json=replicationFactor,proto3" json:"replicationFactor,omitempty"`
	Members           map[github_com_kakao_varlog_pkg_types.NodeID]string `` /* 205-byte string literal not displayed */
}

type GetMetadataRepositoryNodeRequest struct {
	NodeID github_com_kakao_varlog_pkg_types.NodeID `` /* 130-byte string literal not displayed */
}

type GetMetadataRepositoryNodeResponse struct {
	Node *varlogpb.MetadataRepositoryNode `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
}

type GetStorageNodeRequest struct {
	StorageNodeID github_com_kakao_varlog_pkg_types.StorageNodeID `` /* 160-byte string literal not displayed */
}

type GetStorageNodeResponse struct {
	// StorageNode registered to the cluster.
	StorageNode *StorageNodeMetadata `protobuf:"bytes,1,opt,name=storage_node,json=storageNode,proto3" json:"storageNode"`
}

type GetTopicRequest struct {
	TopicID github_com_kakao_varlog_pkg_types.TopicID `` /* 134-byte string literal not displayed */
}

type GetTopicResponse struct {
	Topic *varlogpb.TopicDescriptor `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic"`
}

type ListLogStreamsRequest struct {
	TopicID github_com_kakao_varlog_pkg_types.TopicID `` /* 134-byte string literal not displayed */
}

type ListLogStreamsResponse struct {
	LogStreams []varlogpb.LogStreamDescriptor `protobuf:"bytes,1,rep,name=log_streams,json=logStreams,proto3" json:"logStreams"`
}

type ListMetadataRepositoryNodesRequest struct {
}

type ListMetadataRepositoryNodesResponse struct {
	Nodes []varlogpb.MetadataRepositoryNode `protobuf:"bytes,1,rep,name=nodes,proto3" json:"nodes"`
}

type ListStorageNodesRequest struct {
}

type ListStorageNodesResponse struct {
	// StorageNodes registered to the cluster.
	StorageNodes []StorageNodeMetadata `protobuf:"bytes,1,rep,name=storage_nodes,json=storageNodes,proto3" json:"storageNodes"`
}

type ListTopicsRequest struct {
}

type ListTopicsResponse struct {
	Topics []varlogpb.TopicDescriptor `protobuf:"bytes,1,rep,name=topics,proto3" json:"topics"`
}