Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.4.0

Feb 14, 2023

v0.3.0

Feb 6, 2023

Changes in this version

+ var ShardingStrategy_name = map[int32]string

+ var ShardingStrategy_value = map[string]int32

+ type Node struct

+ Hostname string

+ Id string

+ Quorum uint64

+ Region *Region

+ Shard uint64

+ Url string

+ func (*Node) Descriptor() ([]byte, []int)

+ func (*Node) ProtoMessage()

+ func (x *Node) GetHostname() string

+ func (x *Node) GetId() string

+ func (x *Node) GetQuorum() uint64

+ func (x *Node) GetRegion() *Region

+ func (x *Node) GetShard() uint64

+ func (x *Node) GetUrl() string

+ func (x *Node) ProtoReflect() protoreflect.Message

+ func (x *Node) Reset()

+ func (x *Node) String() string

+ type Placement struct

+ Epoch uint64

+ Nodes []*Node

+ Regions []*Region

+ Sharding ShardingStrategy

+ func (*Placement) Descriptor() ([]byte, []int)

+ func (*Placement) ProtoMessage()

+ func (x *Placement) GetEpoch() uint64

+ func (x *Placement) GetNodes() []*Node

+ func (x *Placement) GetRegions() []*Region

+ func (x *Placement) GetSharding() ShardingStrategy

+ func (x *Placement) ProtoReflect() protoreflect.Message

+ func (x *Placement) Reset()

+ func (x *Placement) String() string

+ type ShardingStrategy int32

+ const ShardingStrategy_CONSISTENT_KEY_HASH

+ const ShardingStrategy_NO_SHARDING

+ const ShardingStrategy_PUBLISHER_ORDERING

+ const ShardingStrategy_RANDOM

+ const ShardingStrategy_UNKNOWN

+ func (ShardingStrategy) Descriptor() protoreflect.EnumDescriptor

+ func (ShardingStrategy) EnumDescriptor() ([]byte, []int)

+ func (ShardingStrategy) Type() protoreflect.EnumType

+ func (x ShardingStrategy) Enum() *ShardingStrategy

+ func (x ShardingStrategy) Number() protoreflect.EnumNumber

+ func (x ShardingStrategy) String() string

type Topic

+ Modified *timestamppb.Timestamp

+ Offset uint64

+ Placements []*Placement

+ ProjectId []byte

+ Shards uint32

+ func (x *Topic) GetModified() *timestamppb.Timestamp

+ func (x *Topic) GetOffset() uint64

+ func (x *Topic) GetPlacements() []*Placement

+ func (x *Topic) GetProjectId() []byte

+ func (x *Topic) GetShards() uint32

v0.2.0

Jan 23, 2023

v0.1.1

Nov 8, 2022

Changes in this version

type Event

+ Key []byte

+ UserDefinedId string

+ func (x *Event) GetKey() []byte

+ func (x *Event) GetUserDefinedId() string

v0.1.0

Oct 13, 2022

Changes in this version

+ var Ensign_ServiceDesc = grpc.ServiceDesc

+ var File_ensign_v1beta1_ensign_proto protoreflect.FileDescriptor

+ var File_ensign_v1beta1_event_proto protoreflect.FileDescriptor

+ var File_ensign_v1beta1_topic_proto protoreflect.FileDescriptor

+ var ServiceState_Status_name = map[int32]string

+ var ServiceState_Status_value = map[string]int32

+ var TopicMod_Operation_name = map[int32]string

+ var TopicMod_Operation_value = map[string]int32

+ var TopicTombstone_Status_name = map[int32]string

+ var TopicTombstone_Status_value = map[string]int32

+ func RegisterEnsignServer(s grpc.ServiceRegistrar, srv EnsignServer)

+ type Ack struct

+ Committed *timestamppb.Timestamp

+ Id string

+ func (*Ack) Descriptor() ([]byte, []int)

+ func (*Ack) ProtoMessage()

+ func (x *Ack) GetCommitted() *timestamppb.Timestamp

+ func (x *Ack) GetId() string

+ func (x *Ack) ProtoReflect() protoreflect.Message

+ func (x *Ack) Reset()

+ func (x *Ack) String() string

+ type CloseStream struct

+ Consumers uint64

+ Events uint64

+ TopicOffset uint64

+ func (*CloseStream) Descriptor() ([]byte, []int)

+ func (*CloseStream) ProtoMessage()

+ func (x *CloseStream) GetConsumers() uint64

+ func (x *CloseStream) GetEvents() uint64

+ func (x *CloseStream) GetTopicOffset() uint64

+ func (x *CloseStream) ProtoReflect() protoreflect.Message

+ func (x *CloseStream) Reset()

+ func (x *CloseStream) String() string

+ type Compression struct

+ Algorithm string

+ func (*Compression) Descriptor() ([]byte, []int)

+ func (*Compression) ProtoMessage()

+ func (x *Compression) GetAlgorithm() string

+ func (x *Compression) ProtoReflect() protoreflect.Message

+ func (x *Compression) Reset()

+ func (x *Compression) String() string

+ type Encryption struct

+ Algorithm string

+ KeyId string

+ func (*Encryption) Descriptor() ([]byte, []int)

+ func (*Encryption) ProtoMessage()

+ func (x *Encryption) GetAlgorithm() string

+ func (x *Encryption) GetKeyId() string

+ func (x *Encryption) ProtoReflect() protoreflect.Message

+ func (x *Encryption) Reset()

+ func (x *Encryption) String() string

+ type EnsignClient interface

+ CreateTopic func(ctx context.Context, in *Topic, opts ...grpc.CallOption) (*Topic, error)

+ DeleteTopic func(ctx context.Context, in *TopicMod, opts ...grpc.CallOption) (*TopicTombstone, error)

+ ListTopics func(ctx context.Context, in *PageInfo, opts ...grpc.CallOption) (*TopicsPage, error)

+ Publish func(ctx context.Context, opts ...grpc.CallOption) (Ensign_PublishClient, error)

+ Status func(ctx context.Context, in *HealthCheck, opts ...grpc.CallOption) (*ServiceState, error)

+ Subscribe func(ctx context.Context, opts ...grpc.CallOption) (Ensign_SubscribeClient, error)

+ func NewEnsignClient(cc grpc.ClientConnInterface) EnsignClient

+ type EnsignServer interface

+ CreateTopic func(context.Context, *Topic) (*Topic, error)

+ DeleteTopic func(context.Context, *TopicMod) (*TopicTombstone, error)

+ ListTopics func(context.Context, *PageInfo) (*TopicsPage, error)

+ Publish func(Ensign_PublishServer) error

+ Status func(context.Context, *HealthCheck) (*ServiceState, error)

+ Subscribe func(Ensign_SubscribeServer) error

+ type Ensign_PublishClient interface

+ Recv func() (*Publication, error)

+ Send func(*Event) error

+ type Ensign_PublishServer interface

+ Recv func() (*Event, error)

+ Send func(*Publication) error

+ type Ensign_SubscribeClient interface

+ Recv func() (*Event, error)

+ Send func(*Subscription) error

+ type Ensign_SubscribeServer interface

+ Recv func() (*Subscription, error)

+ Send func(*Event) error

+ type Event struct

+ Committed *timestamppb.Timestamp

+ Compression *Compression

+ Created *timestamppb.Timestamp

+ Data []byte

+ Encryption *Encryption

+ Geography *Region

+ Id string

+ Mimetype v1beta1.MIME

+ Publisher *Publisher

+ TopicId string

+ Type *Type

+ func (*Event) Descriptor() ([]byte, []int)

+ func (*Event) ProtoMessage()

+ func (x *Event) GetCommitted() *timestamppb.Timestamp

+ func (x *Event) GetCompression() *Compression

+ func (x *Event) GetCreated() *timestamppb.Timestamp

+ func (x *Event) GetData() []byte

+ func (x *Event) GetEncryption() *Encryption

+ func (x *Event) GetGeography() *Region

+ func (x *Event) GetId() string

+ func (x *Event) GetMimetype() v1beta1.MIME

+ func (x *Event) GetPublisher() *Publisher

+ func (x *Event) GetTopicId() string

+ func (x *Event) GetType() *Type

+ func (x *Event) ProtoReflect() protoreflect.Message

+ func (x *Event) Reset()

+ func (x *Event) String() string

+ type HealthCheck struct

+ Attempts uint32

+ LastCheckedAt *timestamppb.Timestamp

+ func (*HealthCheck) Descriptor() ([]byte, []int)

+ func (*HealthCheck) ProtoMessage()

+ func (x *HealthCheck) GetAttempts() uint32

+ func (x *HealthCheck) GetLastCheckedAt() *timestamppb.Timestamp

+ func (x *HealthCheck) ProtoReflect() protoreflect.Message

+ func (x *HealthCheck) Reset()

+ func (x *HealthCheck) String() string

+ type Nack struct

+ Code uint32

+ Error string

+ Id string

+ func (*Nack) Descriptor() ([]byte, []int)

+ func (*Nack) ProtoMessage()

+ func (x *Nack) GetCode() uint32

+ func (x *Nack) GetError() string

+ func (x *Nack) GetId() string

+ func (x *Nack) ProtoReflect() protoreflect.Message

+ func (x *Nack) Reset()

+ func (x *Nack) String() string

+ type OpenStream struct

+ Group string

+ Topic string

+ func (*OpenStream) Descriptor() ([]byte, []int)

+ func (*OpenStream) ProtoMessage()

+ func (x *OpenStream) GetGroup() string

+ func (x *OpenStream) GetTopic() string

+ func (x *OpenStream) ProtoReflect() protoreflect.Message

+ func (x *OpenStream) Reset()

+ func (x *OpenStream) String() string

+ type PageInfo struct

+ NextPageToken string

+ PageSize uint32

+ func (*PageInfo) Descriptor() ([]byte, []int)

+ func (*PageInfo) ProtoMessage()

+ func (x *PageInfo) GetNextPageToken() string

+ func (x *PageInfo) GetPageSize() uint32

+ func (x *PageInfo) ProtoReflect() protoreflect.Message

+ func (x *PageInfo) Reset()

+ func (x *PageInfo) String() string

+ type Publication struct

+ Embed isPublication_Embed

+ func (*Publication) Descriptor() ([]byte, []int)

+ func (*Publication) ProtoMessage()

+ func (m *Publication) GetEmbed() isPublication_Embed

+ func (x *Publication) GetAck() *Ack

+ func (x *Publication) GetCloseStream() *CloseStream

+ func (x *Publication) GetNack() *Nack

+ func (x *Publication) ProtoReflect() protoreflect.Message

+ func (x *Publication) Reset()

+ func (x *Publication) String() string

+ type Publication_Ack struct

+ Ack *Ack

+ type Publication_CloseStream struct

+ CloseStream *CloseStream

+ type Publication_Nack struct

+ Nack *Nack

+ type Publisher struct

+ ClientId string

+ Ipaddr string

+ func (*Publisher) Descriptor() ([]byte, []int)

+ func (*Publisher) ProtoMessage()

+ func (x *Publisher) GetClientId() string

+ func (x *Publisher) GetIpaddr() string

+ func (x *Publisher) ProtoReflect() protoreflect.Message

+ func (x *Publisher) Reset()

+ func (x *Publisher) String() string

+ type Region struct

+ Name string

+ func (*Region) Descriptor() ([]byte, []int)

+ func (*Region) ProtoMessage()

+ func (x *Region) GetName() string

+ func (x *Region) ProtoReflect() protoreflect.Message

+ func (x *Region) Reset()

+ func (x *Region) String() string

+ type ServiceState struct

+ NotAfter *timestamppb.Timestamp

+ NotBefore *timestamppb.Timestamp

+ Status ServiceState_Status

+ Uptime *durationpb.Duration

+ Version string

+ func (*ServiceState) Descriptor() ([]byte, []int)

+ func (*ServiceState) ProtoMessage()

+ func (x *ServiceState) GetNotAfter() *timestamppb.Timestamp

+ func (x *ServiceState) GetNotBefore() *timestamppb.Timestamp

+ func (x *ServiceState) GetStatus() ServiceState_Status

+ func (x *ServiceState) GetUptime() *durationpb.Duration

+ func (x *ServiceState) GetVersion() string

+ func (x *ServiceState) ProtoReflect() protoreflect.Message

+ func (x *ServiceState) Reset()

+ func (x *ServiceState) String() string

+ type ServiceState_Status int32

+ const ServiceState_DANGER

+ const ServiceState_HEALTHY

+ const ServiceState_MAINTENANCE

+ const ServiceState_OFFLINE

+ const ServiceState_UNHEALTHY

+ const ServiceState_UNKNOWN

+ func (ServiceState_Status) Descriptor() protoreflect.EnumDescriptor

+ func (ServiceState_Status) EnumDescriptor() ([]byte, []int)

+ func (ServiceState_Status) Type() protoreflect.EnumType

+ func (x ServiceState_Status) Enum() *ServiceState_Status

+ func (x ServiceState_Status) Number() protoreflect.EnumNumber

+ func (x ServiceState_Status) String() string

+ type Subscription struct

+ Embed isSubscription_Embed

+ func (*Subscription) Descriptor() ([]byte, []int)

+ func (*Subscription) ProtoMessage()

+ func (m *Subscription) GetEmbed() isSubscription_Embed

+ func (x *Subscription) GetAck() *Ack

+ func (x *Subscription) GetNack() *Nack

+ func (x *Subscription) GetOpenStream() *OpenStream

+ func (x *Subscription) ProtoReflect() protoreflect.Message

+ func (x *Subscription) Reset()

+ func (x *Subscription) String() string

+ type Subscription_Ack struct

+ Ack *Ack

+ type Subscription_Nack struct

+ Nack *Nack

+ type Subscription_OpenStream struct

+ OpenStream *OpenStream

+ type Topic struct

+ Created *timestamppb.Timestamp

+ Id string

+ Name string

+ Readonly bool

+ Regions []*Region

+ Types []*Type

+ func (*Topic) Descriptor() ([]byte, []int)

+ func (*Topic) ProtoMessage()

+ func (x *Topic) GetCreated() *timestamppb.Timestamp

+ func (x *Topic) GetId() string

+ func (x *Topic) GetName() string

+ func (x *Topic) GetReadonly() bool

+ func (x *Topic) GetRegions() []*Region

+ func (x *Topic) GetTypes() []*Type

+ func (x *Topic) ProtoReflect() protoreflect.Message

+ func (x *Topic) Reset()

+ func (x *Topic) String() string

+ type TopicMod struct

+ Id string

+ Operation TopicMod_Operation

+ func (*TopicMod) Descriptor() ([]byte, []int)

+ func (*TopicMod) ProtoMessage()

+ func (x *TopicMod) GetId() string

+ func (x *TopicMod) GetOperation() TopicMod_Operation

+ func (x *TopicMod) ProtoReflect() protoreflect.Message

+ func (x *TopicMod) Reset()

+ func (x *TopicMod) String() string

+ type TopicMod_Operation int32

+ const TopicMod_ARCHIVE

+ const TopicMod_DESTROY

+ const TopicMod_NOOP

+ func (TopicMod_Operation) Descriptor() protoreflect.EnumDescriptor

+ func (TopicMod_Operation) EnumDescriptor() ([]byte, []int)

+ func (TopicMod_Operation) Type() protoreflect.EnumType

+ func (x TopicMod_Operation) Enum() *TopicMod_Operation

+ func (x TopicMod_Operation) Number() protoreflect.EnumNumber

+ func (x TopicMod_Operation) String() string

+ type TopicTombstone struct

+ Id string

+ State TopicTombstone_Status

+ func (*TopicTombstone) Descriptor() ([]byte, []int)

+ func (*TopicTombstone) ProtoMessage()

+ func (x *TopicTombstone) GetId() string

+ func (x *TopicTombstone) GetState() TopicTombstone_Status

+ func (x *TopicTombstone) ProtoReflect() protoreflect.Message

+ func (x *TopicTombstone) Reset()

+ func (x *TopicTombstone) String() string

+ type TopicTombstone_Status int32

+ const TopicTombstone_DELETING

+ const TopicTombstone_READONLY

+ const TopicTombstone_UNKNOWN

+ func (TopicTombstone_Status) Descriptor() protoreflect.EnumDescriptor

+ func (TopicTombstone_Status) EnumDescriptor() ([]byte, []int)

+ func (TopicTombstone_Status) Type() protoreflect.EnumType

+ func (x TopicTombstone_Status) Enum() *TopicTombstone_Status

+ func (x TopicTombstone_Status) Number() protoreflect.EnumNumber

+ func (x TopicTombstone_Status) String() string

+ type TopicsPage struct

+ NextPageToken string

+ Topics []*Topic

+ func (*TopicsPage) Descriptor() ([]byte, []int)

+ func (*TopicsPage) ProtoMessage()

+ func (x *TopicsPage) GetNextPageToken() string

+ func (x *TopicsPage) GetTopics() []*Topic

+ func (x *TopicsPage) ProtoReflect() protoreflect.Message

+ func (x *TopicsPage) Reset()

+ func (x *TopicsPage) String() string

+ type Type struct

+ Name string

+ Version uint32

+ func (*Type) Descriptor() ([]byte, []int)

+ func (*Type) ProtoMessage()

+ func (x *Type) GetName() string

+ func (x *Type) GetVersion() uint32

+ func (x *Type) ProtoReflect() protoreflect.Message

+ func (x *Type) Reset()

+ func (x *Type) String() string

+ type UnimplementedEnsignServer struct

+ func (UnimplementedEnsignServer) CreateTopic(context.Context, *Topic) (*Topic, error)

+ func (UnimplementedEnsignServer) DeleteTopic(context.Context, *TopicMod) (*TopicTombstone, error)

+ func (UnimplementedEnsignServer) ListTopics(context.Context, *PageInfo) (*TopicsPage, error)

+ func (UnimplementedEnsignServer) Publish(Ensign_PublishServer) error

+ func (UnimplementedEnsignServer) Status(context.Context, *HealthCheck) (*ServiceState, error)

+ func (UnimplementedEnsignServer) Subscribe(Ensign_SubscribeServer) error

+ type UnsafeEnsignServer interface