v1

package
v0.2.13 Latest Latest
Warning

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

Go to latest
Published: Mar 16, 2023 License: Apache-2.0 Imports: 9 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Cmd_Type_name = map[int32]string{
		0: "PING",
		1: "LOGGING",
		2: "COUNT",
	}
	Cmd_Type_value = map[string]int32{
		"PING":    0,
		"LOGGING": 1,
		"COUNT":   2,
	}
)

Enum value maps for Cmd_Type.

View Source
var AgencyService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "ops.v1.AgencyService",
	HandlerType: (*AgencyServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Onboard",
			Handler:    _AgencyService_Onboard_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "PSMHook",
			Handler:       _AgencyService_PSMHook_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "agency.proto",
}

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

View Source
var DevOpsService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "ops.v1.DevOpsService",
	HandlerType: (*DevOpsServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Enter",
			Handler:    _DevOpsService_Enter_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "agency.proto",
}

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

View Source
var File_agency_proto protoreflect.FileDescriptor

Functions

func RegisterAgencyServiceServer

func RegisterAgencyServiceServer(s grpc.ServiceRegistrar, srv AgencyServiceServer)

func RegisterDevOpsServiceServer

func RegisterDevOpsServiceServer(s grpc.ServiceRegistrar, srv DevOpsServiceServer)

Types

type AgencyServiceClient

type AgencyServiceClient interface {
	// PSMHook listens realtime stream of archived protocol state machines
	PSMHook(ctx context.Context, in *DataHook, opts ...grpc.CallOption) (AgencyService_PSMHookClient, error)
	// Onboard allocates cloud agent and its wallet from Agency
	Onboard(ctx context.Context, in *Onboarding, opts ...grpc.CallOption) (*OnboardResult, error)
}

AgencyServiceClient is the client API for AgencyService 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 AgencyServiceServer

type AgencyServiceServer interface {
	// PSMHook listens realtime stream of archived protocol state machines
	PSMHook(*DataHook, AgencyService_PSMHookServer) error
	// Onboard allocates cloud agent and its wallet from Agency
	Onboard(context.Context, *Onboarding) (*OnboardResult, error)
	// contains filtered or unexported methods
}

AgencyServiceServer is the server API for AgencyService service. All implementations must embed UnimplementedAgencyServiceServer for forward compatibility

type AgencyService_PSMHookClient

type AgencyService_PSMHookClient interface {
	Recv() (*AgencyStatus, error)
	grpc.ClientStream
}

type AgencyService_PSMHookServer

type AgencyService_PSMHookServer interface {
	Send(*AgencyStatus) error
	grpc.ServerStream
}

type AgencyStatus

type AgencyStatus struct {
	ID             string             `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"`
	ProtocolStatus *v1.ProtocolStatus `protobuf:"bytes,2,opt,name=protocol_status,json=protocolStatus,proto3" json:"protocol_status,omitempty"` // Detailed protocol information
	DID            string             `protobuf:"bytes,3,opt,name=DID,proto3" json:"DID,omitempty"`                                             // Agent DID if available
	ConnectionID   string             `protobuf:"bytes,4,opt,name=connectionID,proto3" json:"connectionID,omitempty"`                           // Connection (pairwise) ID if available
	// contains filtered or unexported fields
}

AgencyStatus is message returned by PSMHook. These status messages encapsulates protocol state machine information. The message has its own id. The protocol specific information comes in ProtocolStatus. Outside of the actual protocol but relevant information are current agent DID and Connection ID which arrives in own fields.

func (*AgencyStatus) Descriptor deprecated

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

Deprecated: Use AgencyStatus.ProtoReflect.Descriptor instead.

func (*AgencyStatus) GetConnectionID

func (x *AgencyStatus) GetConnectionID() string

func (*AgencyStatus) GetDID

func (x *AgencyStatus) GetDID() string

func (*AgencyStatus) GetID

func (x *AgencyStatus) GetID() string

func (*AgencyStatus) GetProtocolStatus

func (x *AgencyStatus) GetProtocolStatus() *v1.ProtocolStatus

func (*AgencyStatus) ProtoMessage

func (*AgencyStatus) ProtoMessage()

func (*AgencyStatus) ProtoReflect

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

func (*AgencyStatus) Reset

func (x *AgencyStatus) Reset()

func (*AgencyStatus) String

func (x *AgencyStatus) String() string

type Cmd

type Cmd struct {
	Type Cmd_Type `protobuf:"varint,1,opt,name=type,proto3,enum=ops.v1.Cmd_Type" json:"type,omitempty"`
	// Request is the structure to gather cmd specific arguments to type fields.
	//
	// Types that are assignable to Request:
	//	*Cmd_Logging
	Request isCmd_Request `protobuf_oneof:"Request"`
	// contains filtered or unexported fields
}

Cmd is structure to transport agency cmds.

func (*Cmd) Descriptor deprecated

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

Deprecated: Use Cmd.ProtoReflect.Descriptor instead.

func (*Cmd) GetLogging

func (x *Cmd) GetLogging() string

func (*Cmd) GetRequest

func (m *Cmd) GetRequest() isCmd_Request

func (*Cmd) GetType

func (x *Cmd) GetType() Cmd_Type

func (*Cmd) ProtoMessage

func (*Cmd) ProtoMessage()

func (*Cmd) ProtoReflect

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

func (*Cmd) Reset

func (x *Cmd) Reset()

func (*Cmd) String

func (x *Cmd) String() string

type CmdReturn

type CmdReturn struct {
	Type Cmd_Type `protobuf:"varint,1,opt,name=type,proto3,enum=ops.v1.Cmd_Type" json:"type,omitempty"`
	// Types that are assignable to Response:
	//	*CmdReturn_Ping
	//	*CmdReturn_Count
	Response isCmdReturn_Response `protobuf_oneof:"Response"`
	// contains filtered or unexported fields
}

CmdReturn is structure to return cmd results.

func (*CmdReturn) Descriptor deprecated

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

Deprecated: Use CmdReturn.ProtoReflect.Descriptor instead.

func (*CmdReturn) GetCount

func (x *CmdReturn) GetCount() string

func (*CmdReturn) GetPing

func (x *CmdReturn) GetPing() string

func (*CmdReturn) GetResponse

func (m *CmdReturn) GetResponse() isCmdReturn_Response

func (*CmdReturn) GetType

func (x *CmdReturn) GetType() Cmd_Type

func (*CmdReturn) ProtoMessage

func (*CmdReturn) ProtoMessage()

func (*CmdReturn) ProtoReflect

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

func (*CmdReturn) Reset

func (x *CmdReturn) Reset()

func (*CmdReturn) String

func (x *CmdReturn) String() string

type CmdReturn_Count

type CmdReturn_Count struct {
	Count string `protobuf:"bytes,3,opt,name=count,proto3,oneof"` // Count cmd's result.
}

type CmdReturn_Ping

type CmdReturn_Ping struct {
	Ping string `protobuf:"bytes,2,opt,name=ping,proto3,oneof"` // Ping cmd's result.
}

type Cmd_Logging

type Cmd_Logging struct {
	Logging string `protobuf:"bytes,2,opt,name=logging,proto3,oneof"` // Type is LOGGING includes argument string.
}

type Cmd_Type

type Cmd_Type int32
const (
	Cmd_PING    Cmd_Type = 0
	Cmd_LOGGING Cmd_Type = 1
	Cmd_COUNT   Cmd_Type = 2
)

func (Cmd_Type) Descriptor

func (Cmd_Type) Descriptor() protoreflect.EnumDescriptor

func (Cmd_Type) Enum

func (x Cmd_Type) Enum() *Cmd_Type

func (Cmd_Type) EnumDescriptor deprecated

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

Deprecated: Use Cmd_Type.Descriptor instead.

func (Cmd_Type) Number

func (x Cmd_Type) Number() protoreflect.EnumNumber

func (Cmd_Type) String

func (x Cmd_Type) String() string

func (Cmd_Type) Type

type DataHook

type DataHook struct {
	ID string `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"` // UUID to uniquely identify the hook
	// contains filtered or unexported fields
}

DataHook is structure identify data hook.

func (*DataHook) Descriptor deprecated

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

Deprecated: Use DataHook.ProtoReflect.Descriptor instead.

func (*DataHook) GetID

func (x *DataHook) GetID() string

func (*DataHook) ProtoMessage

func (*DataHook) ProtoMessage()

func (*DataHook) ProtoReflect

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

func (*DataHook) Reset

func (x *DataHook) Reset()

func (*DataHook) String

func (x *DataHook) String() string

type DevOpsServiceClient

type DevOpsServiceClient interface {
	// Enter is the cmd exec interface.
	Enter(ctx context.Context, in *Cmd, opts ...grpc.CallOption) (*CmdReturn, error)
}

DevOpsServiceClient is the client API for DevOpsService 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 DevOpsServiceServer

type DevOpsServiceServer interface {
	// Enter is the cmd exec interface.
	Enter(context.Context, *Cmd) (*CmdReturn, error)
	// contains filtered or unexported methods
}

DevOpsServiceServer is the server API for DevOpsService service. All implementations must embed UnimplementedDevOpsServiceServer for forward compatibility

type OnboardResult

type OnboardResult struct {
	Ok     bool                    `protobuf:"varint,1,opt,name=ok,proto3" json:"ok,omitempty"`        // result if Onboarding was successful.
	Result *OnboardResult_OKResult `protobuf:"bytes,2,opt,name=result,proto3" json:"result,omitempty"` // Instance of the OK result.
	// contains filtered or unexported fields
}

OnboardResult is structure to transport Onboarding result.

func (*OnboardResult) Descriptor deprecated

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

Deprecated: Use OnboardResult.ProtoReflect.Descriptor instead.

func (*OnboardResult) GetOk

func (x *OnboardResult) GetOk() bool

func (*OnboardResult) GetResult

func (x *OnboardResult) GetResult() *OnboardResult_OKResult

func (*OnboardResult) ProtoMessage

func (*OnboardResult) ProtoMessage()

func (*OnboardResult) ProtoReflect

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

func (*OnboardResult) Reset

func (x *OnboardResult) Reset()

func (*OnboardResult) String

func (x *OnboardResult) String() string

type OnboardResult_OKResult

type OnboardResult_OKResult struct {
	JWT            string `protobuf:"bytes,1,opt,name=JWT,proto3" json:"JWT,omitempty"`                       // pregenerated JWT token, mostly usefull for development.
	CADID          string `protobuf:"bytes,2,opt,name=CADID,proto3" json:"CADID,omitempty"`                   // Cloud Agent DID. The UID for CA.
	InvitationJSON string `protobuf:"bytes,3,opt,name=invitationJSON,proto3" json:"invitationJSON,omitempty"` // pregenerated Invitation, mostly in dev use.
	// contains filtered or unexported fields
}

func (*OnboardResult_OKResult) Descriptor deprecated

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

Deprecated: Use OnboardResult_OKResult.ProtoReflect.Descriptor instead.

func (*OnboardResult_OKResult) GetCADID

func (x *OnboardResult_OKResult) GetCADID() string

func (*OnboardResult_OKResult) GetInvitationJSON

func (x *OnboardResult_OKResult) GetInvitationJSON() string

func (*OnboardResult_OKResult) GetJWT

func (x *OnboardResult_OKResult) GetJWT() string

func (*OnboardResult_OKResult) ProtoMessage

func (*OnboardResult_OKResult) ProtoMessage()

func (*OnboardResult_OKResult) ProtoReflect

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

func (*OnboardResult_OKResult) Reset

func (x *OnboardResult_OKResult) Reset()

func (*OnboardResult_OKResult) String

func (x *OnboardResult_OKResult) String() string

type Onboarding

type Onboarding struct {
	Email         string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`                 // email is then name or handle used for pointing the CA.
	PublicDIDSeed string `protobuf:"bytes,2,opt,name=publicDIDSeed,proto3" json:"publicDIDSeed,omitempty"` // public DID seed is used to generate CA's DID (optional)
	// contains filtered or unexported fields
}

Onboarding is structure for cloud agent (CA) onboarding.

func (*Onboarding) Descriptor deprecated

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

Deprecated: Use Onboarding.ProtoReflect.Descriptor instead.

func (*Onboarding) GetEmail

func (x *Onboarding) GetEmail() string

func (*Onboarding) GetPublicDIDSeed added in v0.1.24

func (x *Onboarding) GetPublicDIDSeed() string

func (*Onboarding) ProtoMessage

func (*Onboarding) ProtoMessage()

func (*Onboarding) ProtoReflect

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

func (*Onboarding) Reset

func (x *Onboarding) Reset()

func (*Onboarding) String

func (x *Onboarding) String() string

type UnimplementedAgencyServiceServer

type UnimplementedAgencyServiceServer struct {
}

UnimplementedAgencyServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedAgencyServiceServer) Onboard

func (UnimplementedAgencyServiceServer) PSMHook

type UnimplementedDevOpsServiceServer

type UnimplementedDevOpsServiceServer struct {
}

UnimplementedDevOpsServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedDevOpsServiceServer) Enter

type UnsafeAgencyServiceServer

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

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

type UnsafeDevOpsServiceServer

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

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

Jump to

Keyboard shortcuts

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