protos

package
v0.0.0-...-f385b4b Latest Latest
Warning

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

 Go to latest Published: Jul 16, 2024 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	SubscriptionErrorType_name = map[int32]string{
		0: "UNKNOWN",
		1: "INVALID_JWT",
	}
	SubscriptionErrorType_value = map[string]int32{
		"UNKNOWN":     0,
		"INVALID_JWT": 1,
	}
)

Enum value maps for SubscriptionErrorType.

View Source 
var (
	OperatingSystemName_name = map[int32]string{
		0: "UNKNOWN_OPERATING_SYSTEM",
		1: "IOS",
		2: "ANDROID",
		3: "INT_TEST",
		4: "MANUAL_TEST",
		5: "WEB",
	}
	OperatingSystemName_value = map[string]int32{
		"UNKNOWN_OPERATING_SYSTEM": 0,
		"IOS":                      1,
		"ANDROID":                  2,
		"INT_TEST":                 3,
		"MANUAL_TEST":              4,
		"WEB":                      5,
	}
)

Enum value maps for OperatingSystemName.

View Source 
var (
	ResubscribeToAppTwinResponse_ResubscribeResult_name = map[int32]string{
		0: "UNKNOWN_ERROR",
		1: "SUCCESS",
		2: "INVALID_JWT_ERROR",
		3: "TARGET_DOES_NOT_EXIST",
	}
	ResubscribeToAppTwinResponse_ResubscribeResult_value = map[string]int32{
		"UNKNOWN_ERROR":         0,
		"SUCCESS":               1,
		"INVALID_JWT_ERROR":     2,
		"TARGET_DOES_NOT_EXIST": 3,
	}
)

Enum value maps for ResubscribeToAppTwinResponse_ResubscribeResult.

View Source 
var File_protos_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AcknowledgeAssignedVehicles 

type AcknowledgeAssignedVehicles struct {
	// contains filtered or unexported fields
}

func (*AcknowledgeAssignedVehicles) Descriptor deprecated 

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

Deprecated: Use AcknowledgeAssignedVehicles.ProtoReflect.Descriptor instead.

func (*AcknowledgeAssignedVehicles) ProtoMessage 

func (*AcknowledgeAssignedVehicles) ProtoMessage()

func (*AcknowledgeAssignedVehicles) ProtoReflect 

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

func (*AcknowledgeAssignedVehicles) Reset 

func (x *AcknowledgeAssignedVehicles) Reset()

func (*AcknowledgeAssignedVehicles) String 

func (x *AcknowledgeAssignedVehicles) String() string

type AssignedVehicles 

type AssignedVehicles struct {
	Vins []string `protobuf:"bytes,1,rep,name=vins,proto3" json:"vins,omitempty"`
	// contains filtered or unexported fields
}

This message is used to tell the App which vehicles are assigned to the current user. The message is sent when the AppTwin is fully initialized (i.e. when it received the first vcb-response)

The list of VINs is needed when a user gets unassigned from a vehicle while not connected to an AppTwin In this case the vehicle would still show in the app the next time the user starts it (see https://appsfactory.atlassian.net/browse/DAIM-3831) To prevent this, we tell the App which VINs are assigned via this message

func (*AssignedVehicles) Descriptor deprecated 

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

Deprecated: Use AssignedVehicles.ProtoReflect.Descriptor instead.

func (*AssignedVehicles) GetVins 

func (x *AssignedVehicles) GetVins() []string

func (*AssignedVehicles) ProtoMessage 

func (*AssignedVehicles) ProtoMessage()

func (*AssignedVehicles) ProtoReflect 

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

func (*AssignedVehicles) Reset 

func (x *AssignedVehicles) Reset()

func (*AssignedVehicles) String 

func (x *AssignedVehicles) String() string

type Heartbeat 

type Heartbeat struct {
	// contains filtered or unexported fields
}

func (*Heartbeat) Descriptor deprecated 

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

Deprecated: Use Heartbeat.ProtoReflect.Descriptor instead.

func (*Heartbeat) ProtoMessage 

func (*Heartbeat) ProtoMessage()

func (*Heartbeat) ProtoReflect 

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

func (*Heartbeat) Reset 

func (x *Heartbeat) Reset()

func (*Heartbeat) String 

func (x *Heartbeat) String() string

type OperatingSystemName 

type OperatingSystemName int32
const (
	OperatingSystemName_UNKNOWN_OPERATING_SYSTEM OperatingSystemName = 0
	OperatingSystemName_IOS                      OperatingSystemName = 1
	OperatingSystemName_ANDROID                  OperatingSystemName = 2
	OperatingSystemName_INT_TEST                 OperatingSystemName = 3
	OperatingSystemName_MANUAL_TEST              OperatingSystemName = 4
	OperatingSystemName_WEB                      OperatingSystemName = 5
)

func (OperatingSystemName) Descriptor 

func (OperatingSystemName) Descriptor() protoreflect.EnumDescriptor

func (OperatingSystemName) Enum 

func (x OperatingSystemName) Enum() *OperatingSystemName

func (OperatingSystemName) EnumDescriptor deprecated 

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

Deprecated: Use OperatingSystemName.Descriptor instead.

func (OperatingSystemName) Number 

func (x OperatingSystemName) Number() protoreflect.EnumNumber

func (OperatingSystemName) String 

func (x OperatingSystemName) String() string

func (OperatingSystemName) Type 

func (OperatingSystemName) Type() protoreflect.EnumType

type ResubscribeToAppTwinRequest 

type ResubscribeToAppTwinRequest struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	CiamId    string `protobuf:"bytes,2,opt,name=ciam_id,json=ciamId,proto3" json:"ciam_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ResubscribeToAppTwinRequest) Descriptor deprecated 

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

Deprecated: Use ResubscribeToAppTwinRequest.ProtoReflect.Descriptor instead.

func (*ResubscribeToAppTwinRequest) GetCiamId 

func (x *ResubscribeToAppTwinRequest) GetCiamId() string

func (*ResubscribeToAppTwinRequest) GetSessionId 

func (x *ResubscribeToAppTwinRequest) GetSessionId() string

func (*ResubscribeToAppTwinRequest) ProtoMessage 

func (*ResubscribeToAppTwinRequest) ProtoMessage()

func (*ResubscribeToAppTwinRequest) ProtoReflect 

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

func (*ResubscribeToAppTwinRequest) Reset 

func (x *ResubscribeToAppTwinRequest) Reset()

func (*ResubscribeToAppTwinRequest) String 

func (x *ResubscribeToAppTwinRequest) String() string

type ResubscribeToAppTwinResponse 

type ResubscribeToAppTwinResponse struct {
	Result ResubscribeToAppTwinResponse_ResubscribeResult `protobuf:"varint,1,opt,name=result,proto3,enum=proto.ResubscribeToAppTwinResponse_ResubscribeResult" json:"result,omitempty"`
	// contains filtered or unexported fields
}

func (*ResubscribeToAppTwinResponse) Descriptor deprecated 

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

Deprecated: Use ResubscribeToAppTwinResponse.ProtoReflect.Descriptor instead.

func (*ResubscribeToAppTwinResponse) GetResult 

func (x *ResubscribeToAppTwinResponse) GetResult() ResubscribeToAppTwinResponse_ResubscribeResult

func (*ResubscribeToAppTwinResponse) ProtoMessage 

func (*ResubscribeToAppTwinResponse) ProtoMessage()

func (*ResubscribeToAppTwinResponse) ProtoReflect 

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

func (*ResubscribeToAppTwinResponse) Reset 

func (x *ResubscribeToAppTwinResponse) Reset()

func (*ResubscribeToAppTwinResponse) String 

func (x *ResubscribeToAppTwinResponse) String() string

type ResubscribeToAppTwinResponse_ResubscribeResult 

type ResubscribeToAppTwinResponse_ResubscribeResult int32
const (
	ResubscribeToAppTwinResponse_UNKNOWN_ERROR         ResubscribeToAppTwinResponse_ResubscribeResult = 0
	ResubscribeToAppTwinResponse_SUCCESS               ResubscribeToAppTwinResponse_ResubscribeResult = 1
	ResubscribeToAppTwinResponse_INVALID_JWT_ERROR     ResubscribeToAppTwinResponse_ResubscribeResult = 2
	ResubscribeToAppTwinResponse_TARGET_DOES_NOT_EXIST ResubscribeToAppTwinResponse_ResubscribeResult = 3
)

func (ResubscribeToAppTwinResponse_ResubscribeResult) Descriptor 

func (ResubscribeToAppTwinResponse_ResubscribeResult) Descriptor() protoreflect.EnumDescriptor

func (ResubscribeToAppTwinResponse_ResubscribeResult) Enum 

func (x ResubscribeToAppTwinResponse_ResubscribeResult) Enum() *ResubscribeToAppTwinResponse_ResubscribeResult

func (ResubscribeToAppTwinResponse_ResubscribeResult) EnumDescriptor deprecated 

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

Deprecated: Use ResubscribeToAppTwinResponse_ResubscribeResult.Descriptor instead.

func (ResubscribeToAppTwinResponse_ResubscribeResult) Number 

func (x ResubscribeToAppTwinResponse_ResubscribeResult) Number() protoreflect.EnumNumber

func (ResubscribeToAppTwinResponse_ResubscribeResult) String 

func (x ResubscribeToAppTwinResponse_ResubscribeResult) String() string

func (ResubscribeToAppTwinResponse_ResubscribeResult) Type 

func (ResubscribeToAppTwinResponse_ResubscribeResult) Type() protoreflect.EnumType

type SubscribeRequest 

type SubscribeRequest struct {

	// An array of topics for which the Subscriber wants to be notified from the Receiver of this message
	Topics []string `protobuf:"bytes,1,rep,name=topics,proto3" json:"topics,omitempty"`
	// indicates whether the previous set of topics should be replaced or whether the content of
	// topics should be merged into the already existing set of topics in the publisher actor. E.g. You're already
	// subscribed to topics A and B. If you send a SubscribeRequest with B and C:
	// replace = true -> you are subscribed to B and C
	// replace = false -> you are subscribed to A, B and C
	Replace bool `protobuf:"varint,2,opt,name=replace,proto3" json:"replace,omitempty"`
	// contains filtered or unexported fields
}

SubscriptionRequest is sent to an actor to indicate that the sender wants to subscribe to events of specific topics. By convention the "Sender" property of the actor message is the Subscriber and will receive the events.

func (*SubscribeRequest) Descriptor deprecated 

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

Deprecated: Use SubscribeRequest.ProtoReflect.Descriptor instead.

func (*SubscribeRequest) GetReplace 

func (x *SubscribeRequest) GetReplace() bool

func (*SubscribeRequest) GetTopics 

func (x *SubscribeRequest) GetTopics() []string

func (*SubscribeRequest) ProtoMessage 

func (*SubscribeRequest) ProtoMessage()

func (*SubscribeRequest) ProtoReflect 

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

func (*SubscribeRequest) Reset 

func (x *SubscribeRequest) Reset()

func (*SubscribeRequest) String 

func (x *SubscribeRequest) String() string

type SubscribeResponse 

type SubscribeResponse struct {
	Success          bool                          `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	Errors           map[string]*SubscriptionError `` /* 153-byte string literal not displayed */
	SubscribedTopics []string                      `protobuf:"bytes,3,rep,name=subscribed_topics,json=subscribedTopics,proto3" json:"subscribed_topics,omitempty"`
	// contains filtered or unexported fields
}

SubscribeResponse is returned by the actor which received a SubscribeRequest. In case of a successful subscription success will be true and error_codes empty/nil. In case of an error the errors map will contain information that points to the reason for failure. The error map's keys are topics that have resulted in an error. The message also contains all successfully subscribed topics under the `subscribed_topics` key. By convention if an SubscribeRequest is sent for topics that have already been subscribed to, the SubscribeResponse will be successful and no error will be returned.

func (*SubscribeResponse) Descriptor deprecated 

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

Deprecated: Use SubscribeResponse.ProtoReflect.Descriptor instead.

func (*SubscribeResponse) GetErrors 

func (x *SubscribeResponse) GetErrors() map[string]*SubscriptionError

func (*SubscribeResponse) GetSubscribedTopics 

func (x *SubscribeResponse) GetSubscribedTopics() []string

func (*SubscribeResponse) GetSuccess 

func (x *SubscribeResponse) GetSuccess() bool

func (*SubscribeResponse) ProtoMessage 

func (*SubscribeResponse) ProtoMessage()

func (*SubscribeResponse) ProtoReflect 

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

func (*SubscribeResponse) Reset 

func (x *SubscribeResponse) Reset()

func (*SubscribeResponse) String 

func (x *SubscribeResponse) String() string

type SubscribeToAppTwinRequest 

type SubscribeToAppTwinRequest struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	CiamId    string `protobuf:"bytes,2,opt,name=ciam_id,json=ciamId,proto3" json:"ciam_id,omitempty"`
	// additional data
	DeviceLocale   string              `protobuf:"bytes,3,opt,name=device_locale,json=deviceLocale,proto3" json:"device_locale,omitempty"`
	AppId          string              `protobuf:"bytes,4,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
	AppVersion     string              `protobuf:"bytes,5,opt,name=app_version,json=appVersion,proto3" json:"app_version,omitempty"`
	OsName         OperatingSystemName `protobuf:"varint,6,opt,name=os_name,json=osName,proto3,enum=proto.OperatingSystemName" json:"os_name,omitempty"`
	OsVersion      string              `protobuf:"bytes,7,opt,name=os_version,json=osVersion,proto3" json:"os_version,omitempty"`
	DeviceModel    string              `protobuf:"bytes,8,opt,name=device_model,json=deviceModel,proto3" json:"device_model,omitempty"`
	NetworkCarrier string              `protobuf:"bytes,9,opt,name=network_carrier,json=networkCarrier,proto3" json:"network_carrier,omitempty"`
	SdkVersion     string              `protobuf:"bytes,10,opt,name=sdk_version,json=sdkVersion,proto3" json:"sdk_version,omitempty"`
	// contains filtered or unexported fields
}

Sent from Websocket-Service -> AppTwin

func (*SubscribeToAppTwinRequest) Descriptor deprecated 

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

Deprecated: Use SubscribeToAppTwinRequest.ProtoReflect.Descriptor instead.

func (*SubscribeToAppTwinRequest) GetAppId 

func (x *SubscribeToAppTwinRequest) GetAppId() string

func (*SubscribeToAppTwinRequest) GetAppVersion 

func (x *SubscribeToAppTwinRequest) GetAppVersion() string

func (*SubscribeToAppTwinRequest) GetCiamId 

func (x *SubscribeToAppTwinRequest) GetCiamId() string

func (*SubscribeToAppTwinRequest) GetDeviceLocale 

func (x *SubscribeToAppTwinRequest) GetDeviceLocale() string

func (*SubscribeToAppTwinRequest) GetDeviceModel 

func (x *SubscribeToAppTwinRequest) GetDeviceModel() string

func (*SubscribeToAppTwinRequest) GetNetworkCarrier 

func (x *SubscribeToAppTwinRequest) GetNetworkCarrier() string

func (*SubscribeToAppTwinRequest) GetOsName 

func (x *SubscribeToAppTwinRequest) GetOsName() OperatingSystemName

func (*SubscribeToAppTwinRequest) GetOsVersion 

func (x *SubscribeToAppTwinRequest) GetOsVersion() string

func (*SubscribeToAppTwinRequest) GetSdkVersion 

func (x *SubscribeToAppTwinRequest) GetSdkVersion() string

func (*SubscribeToAppTwinRequest) GetSessionId 

func (x *SubscribeToAppTwinRequest) GetSessionId() string

func (*SubscribeToAppTwinRequest) ProtoMessage 

func (*SubscribeToAppTwinRequest) ProtoMessage()

func (*SubscribeToAppTwinRequest) ProtoReflect 

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

func (*SubscribeToAppTwinRequest) Reset 

func (x *SubscribeToAppTwinRequest) Reset()

func (*SubscribeToAppTwinRequest) String 

func (x *SubscribeToAppTwinRequest) String() string

type SubscribeToAppTwinResponse 

type SubscribeToAppTwinResponse struct {
	Success   bool                  `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	ErrorCode SubscriptionErrorType `protobuf:"varint,2,opt,name=error_code,json=errorCode,proto3,enum=proto.SubscriptionErrorType" json:"error_code,omitempty"`
	// contains filtered or unexported fields
}

Sent from AppTwin -> Websocket-Service

func (*SubscribeToAppTwinResponse) Descriptor deprecated 

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

Deprecated: Use SubscribeToAppTwinResponse.ProtoReflect.Descriptor instead.

func (*SubscribeToAppTwinResponse) GetErrorCode 

func (x *SubscribeToAppTwinResponse) GetErrorCode() SubscriptionErrorType

func (*SubscribeToAppTwinResponse) GetSuccess 

func (x *SubscribeToAppTwinResponse) GetSuccess() bool

func (*SubscribeToAppTwinResponse) ProtoMessage 

func (*SubscribeToAppTwinResponse) ProtoMessage()

func (*SubscribeToAppTwinResponse) ProtoReflect 

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

func (*SubscribeToAppTwinResponse) Reset 

func (x *SubscribeToAppTwinResponse) Reset()

func (*SubscribeToAppTwinResponse) String 

func (x *SubscribeToAppTwinResponse) String() string

type SubscriptionError 

type SubscriptionError struct {
	Code    []SubscriptionErrorType `protobuf:"varint,1,rep,packed,name=code,proto3,enum=proto.SubscriptionErrorType" json:"code,omitempty"`
	Message []string                `protobuf:"bytes,2,rep,name=message,proto3" json:"message,omitempty"` // Optional
	// contains filtered or unexported fields
}

func (*SubscriptionError) Descriptor deprecated 

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

Deprecated: Use SubscriptionError.ProtoReflect.Descriptor instead.

func (*SubscriptionError) GetCode 

func (x *SubscriptionError) GetCode() []SubscriptionErrorType

func (*SubscriptionError) GetMessage 

func (x *SubscriptionError) GetMessage() []string

func (*SubscriptionError) ProtoMessage 

func (*SubscriptionError) ProtoMessage()

func (*SubscriptionError) ProtoReflect 

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

func (*SubscriptionError) Reset 

func (x *SubscriptionError) Reset()

func (*SubscriptionError) String 

func (x *SubscriptionError) String() string

type SubscriptionErrorType 

type SubscriptionErrorType int32
const (
	SubscriptionErrorType_UNKNOWN     SubscriptionErrorType = 0
	SubscriptionErrorType_INVALID_JWT SubscriptionErrorType = 1
)

func (SubscriptionErrorType) Descriptor 

func (SubscriptionErrorType) Descriptor() protoreflect.EnumDescriptor

func (SubscriptionErrorType) Enum 

func (x SubscriptionErrorType) Enum() *SubscriptionErrorType

func (SubscriptionErrorType) EnumDescriptor deprecated 

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

Deprecated: Use SubscriptionErrorType.Descriptor instead.

func (SubscriptionErrorType) Number 

func (x SubscriptionErrorType) Number() protoreflect.EnumNumber

func (SubscriptionErrorType) String 

func (x SubscriptionErrorType) String() string

func (SubscriptionErrorType) Type 

func (SubscriptionErrorType) Type() protoreflect.EnumType

type UnsubscribeFromAppTwinRequest 

type UnsubscribeFromAppTwinRequest struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// contains filtered or unexported fields
}

func (*UnsubscribeFromAppTwinRequest) Descriptor deprecated 

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

Deprecated: Use UnsubscribeFromAppTwinRequest.ProtoReflect.Descriptor instead.

func (*UnsubscribeFromAppTwinRequest) GetSessionId 

func (x *UnsubscribeFromAppTwinRequest) GetSessionId() string

func (*UnsubscribeFromAppTwinRequest) ProtoMessage 

func (*UnsubscribeFromAppTwinRequest) ProtoMessage()

func (*UnsubscribeFromAppTwinRequest) ProtoReflect 

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

func (*UnsubscribeFromAppTwinRequest) Reset 

func (x *UnsubscribeFromAppTwinRequest) Reset()

func (*UnsubscribeFromAppTwinRequest) String 

func (x *UnsubscribeFromAppTwinRequest) String() string

type UnsubscribeFromAppTwinResponse 

type UnsubscribeFromAppTwinResponse struct {
	Success bool                          `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	Errors  map[string]*SubscriptionError `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*UnsubscribeFromAppTwinResponse) Descriptor deprecated 

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

Deprecated: Use UnsubscribeFromAppTwinResponse.ProtoReflect.Descriptor instead.

func (*UnsubscribeFromAppTwinResponse) GetErrors 

func (x *UnsubscribeFromAppTwinResponse) GetErrors() map[string]*SubscriptionError

func (*UnsubscribeFromAppTwinResponse) GetSuccess 

func (x *UnsubscribeFromAppTwinResponse) GetSuccess() bool

func (*UnsubscribeFromAppTwinResponse) ProtoMessage 

func (*UnsubscribeFromAppTwinResponse) ProtoMessage()

func (*UnsubscribeFromAppTwinResponse) ProtoReflect 

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

func (*UnsubscribeFromAppTwinResponse) Reset 

func (x *UnsubscribeFromAppTwinResponse) Reset()

func (*UnsubscribeFromAppTwinResponse) String 

func (x *UnsubscribeFromAppTwinResponse) String() string

type UnsubscribeRequest 

type UnsubscribeRequest struct {

	// An array of topics for which the Subscriber does not want to receive any more messages
	Topics []string `protobuf:"bytes,1,rep,name=topics,proto3" json:"topics,omitempty"`
	// Whether the publisher should respond
	AnticipateResponse bool `protobuf:"varint,2,opt,name=anticipate_response,json=anticipateResponse,proto3" json:"anticipate_response,omitempty"`
	// contains filtered or unexported fields
}

UnsubscribeRequest is sent to an actor to indicate that the sender wants to unsubscribe from events specified by the topics array.

func (*UnsubscribeRequest) Descriptor deprecated 

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

Deprecated: Use UnsubscribeRequest.ProtoReflect.Descriptor instead.

func (*UnsubscribeRequest) GetAnticipateResponse 

func (x *UnsubscribeRequest) GetAnticipateResponse() bool

func (*UnsubscribeRequest) GetTopics 

func (x *UnsubscribeRequest) GetTopics() []string

func (*UnsubscribeRequest) ProtoMessage 

func (*UnsubscribeRequest) ProtoMessage()

func (*UnsubscribeRequest) ProtoReflect 

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

func (*UnsubscribeRequest) Reset 

func (x *UnsubscribeRequest) Reset()

func (*UnsubscribeRequest) String 

func (x *UnsubscribeRequest) String() string

type UnsubscribeResponse 

type UnsubscribeResponse struct {
	Success            bool                          `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	Errors             map[string]*SubscriptionError `` /* 153-byte string literal not displayed */
	UnsubscribedTopics []string                      `protobuf:"bytes,3,rep,name=unsubscribed_topics,json=unsubscribedTopics,proto3" json:"unsubscribed_topics,omitempty"`
	// contains filtered or unexported fields
}

UnsubscribeResponse is returned by the actor which received a UnsubscribeRequest. In case of a successful removal, success will be true and error_codes empty/nil. In case of an error the errors map will contain information that points to the reason for failure. The error map's keys are topics that have resulted in an error. The message also contains all successfully subscribed topics under the `unsubscribed_topics` key. By convention if an UnsubscribeRequest is sent for topics that have already been unsubscribed from the UnsubscribeResponse will be successful and no error will be returned.

func (*UnsubscribeResponse) Descriptor deprecated 

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

Deprecated: Use UnsubscribeResponse.ProtoReflect.Descriptor instead.

func (*UnsubscribeResponse) GetErrors 

func (x *UnsubscribeResponse) GetErrors() map[string]*SubscriptionError

func (*UnsubscribeResponse) GetSuccess 

func (x *UnsubscribeResponse) GetSuccess() bool

func (*UnsubscribeResponse) GetUnsubscribedTopics 

func (x *UnsubscribeResponse) GetUnsubscribedTopics() []string

func (*UnsubscribeResponse) ProtoMessage 

func (*UnsubscribeResponse) ProtoMessage()

func (*UnsubscribeResponse) ProtoReflect 

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

func (*UnsubscribeResponse) Reset 

func (x *UnsubscribeResponse) Reset()

func (*UnsubscribeResponse) String 

func (x *UnsubscribeResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.