info

package
v1.0.0-beta.45 Latest Latest
Warning

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

Go to latest
Published: Jan 19, 2024 License: MIT Imports: 10 Imported by: 3

Documentation

Index

Constants

View Source
const (
	AuthProvider_AddAccount_FullMethodName               = "/smartcore.info.AuthProvider/AddAccount"
	AuthProvider_RemoveAccount_FullMethodName            = "/smartcore.info.AuthProvider/RemoveAccount"
	AuthProvider_UpdateAccountPermissions_FullMethodName = "/smartcore.info.AuthProvider/UpdateAccountPermissions"
	AuthProvider_GenerateToken_FullMethodName            = "/smartcore.info.AuthProvider/GenerateToken"
)
View Source
const (
	Health_GetHealthState_FullMethodName   = "/smartcore.info.Health/GetHealthState"
	Health_PullHealthStates_FullMethodName = "/smartcore.info.Health/PullHealthStates"
)
View Source
const (
	Info_ListDevices_FullMethodName = "/smartcore.info.Info/ListDevices"
	Info_PullDevices_FullMethodName = "/smartcore.info.Info/PullDevices"
)

Variables

View Source
var AuthProvider_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "smartcore.info.AuthProvider",
	HandlerType: (*AuthProviderServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "AddAccount",
			Handler:    _AuthProvider_AddAccount_Handler,
		},
		{
			MethodName: "RemoveAccount",
			Handler:    _AuthProvider_RemoveAccount_Handler,
		},
		{
			MethodName: "UpdateAccountPermissions",
			Handler:    _AuthProvider_UpdateAccountPermissions_Handler,
		},
		{
			MethodName: "GenerateToken",
			Handler:    _AuthProvider_GenerateToken_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "info/auth.proto",
}

AuthProvider_ServiceDesc is the grpc.ServiceDesc for AuthProvider 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_info_auth_proto protoreflect.FileDescriptor
View Source
var File_info_health_proto protoreflect.FileDescriptor
View Source
var File_info_info_proto protoreflect.FileDescriptor
View Source
var Health_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "smartcore.info.Health",
	HandlerType: (*HealthServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetHealthState",
			Handler:    _Health_GetHealthState_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "PullHealthStates",
			Handler:       _Health_PullHealthStates_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "info/health.proto",
}

Health_ServiceDesc is the grpc.ServiceDesc for Health 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 Info_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "smartcore.info.Info",
	HandlerType: (*InfoServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListDevices",
			Handler:    _Info_ListDevices_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "PullDevices",
			Handler:       _Info_PullDevices_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "info/info.proto",
}

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

Functions

func RegisterAuthProviderServer

func RegisterAuthProviderServer(s grpc.ServiceRegistrar, srv AuthProviderServer)

func RegisterHealthServer

func RegisterHealthServer(s grpc.ServiceRegistrar, srv HealthServer)

func RegisterInfoServer

func RegisterInfoServer(s grpc.ServiceRegistrar, srv InfoServer)

Types

type Account

type Account struct {

	// The account identifier
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A descriptive name for this account
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// The current token for this account
	Token *Token `protobuf:"bytes,3,opt,name=token,proto3" json:"token,omitempty"`
	// The set of permissions granted to the token bearer
	Permissions []*Permission `protobuf:"bytes,4,rep,name=permissions,proto3" json:"permissions,omitempty"`
	// contains filtered or unexported fields
}

Represents an account which has access to this system

func (*Account) Descriptor deprecated

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

Deprecated: Use Account.ProtoReflect.Descriptor instead.

func (*Account) GetName

func (x *Account) GetName() string

func (*Account) GetPermissions

func (x *Account) GetPermissions() []*Permission

func (*Account) GetTitle

func (x *Account) GetTitle() string

func (*Account) GetToken

func (x *Account) GetToken() *Token

func (*Account) ProtoMessage

func (*Account) ProtoMessage()

func (*Account) ProtoReflect

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

func (*Account) Reset

func (x *Account) Reset()

func (*Account) String

func (x *Account) String() string

type AddAccountRequest

type AddAccountRequest struct {
	Name        string        `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Title       string        `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	Permissions []*Permission `protobuf:"bytes,3,rep,name=permissions,proto3" json:"permissions,omitempty"`
	// contains filtered or unexported fields
}

func (*AddAccountRequest) Descriptor deprecated

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

Deprecated: Use AddAccountRequest.ProtoReflect.Descriptor instead.

func (*AddAccountRequest) GetName

func (x *AddAccountRequest) GetName() string

func (*AddAccountRequest) GetPermissions

func (x *AddAccountRequest) GetPermissions() []*Permission

func (*AddAccountRequest) GetTitle

func (x *AddAccountRequest) GetTitle() string

func (*AddAccountRequest) ProtoMessage

func (*AddAccountRequest) ProtoMessage()

func (*AddAccountRequest) ProtoReflect

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

func (*AddAccountRequest) Reset

func (x *AddAccountRequest) Reset()

func (*AddAccountRequest) String

func (x *AddAccountRequest) String() string

type AddAccountResponse

type AddAccountResponse struct {
	Account *Account `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
	// contains filtered or unexported fields
}

func (*AddAccountResponse) Descriptor deprecated

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

Deprecated: Use AddAccountResponse.ProtoReflect.Descriptor instead.

func (*AddAccountResponse) GetAccount

func (x *AddAccountResponse) GetAccount() *Account

func (*AddAccountResponse) ProtoMessage

func (*AddAccountResponse) ProtoMessage()

func (*AddAccountResponse) ProtoReflect

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

func (*AddAccountResponse) Reset

func (x *AddAccountResponse) Reset()

func (*AddAccountResponse) String

func (x *AddAccountResponse) String() string

type AuthProviderClient

type AuthProviderClient interface {
	AddAccount(ctx context.Context, in *AddAccountRequest, opts ...grpc.CallOption) (*AddAccountResponse, error)
	RemoveAccount(ctx context.Context, in *RemoveAccountRequest, opts ...grpc.CallOption) (*RemoveAccountResponse, error)
	UpdateAccountPermissions(ctx context.Context, in *UpdateAccountPermissionsRequest, opts ...grpc.CallOption) (*UpdateAccountPermissionsResponse, error)
	GenerateToken(ctx context.Context, in *GenerateTokenRequest, opts ...grpc.CallOption) (*GenerateTokenResponse, error)
}

AuthProviderClient is the client API for AuthProvider 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 AuthProviderServer

type AuthProviderServer interface {
	AddAccount(context.Context, *AddAccountRequest) (*AddAccountResponse, error)
	RemoveAccount(context.Context, *RemoveAccountRequest) (*RemoveAccountResponse, error)
	UpdateAccountPermissions(context.Context, *UpdateAccountPermissionsRequest) (*UpdateAccountPermissionsResponse, error)
	GenerateToken(context.Context, *GenerateTokenRequest) (*GenerateTokenResponse, error)
	// contains filtered or unexported methods
}

AuthProviderServer is the server API for AuthProvider service. All implementations must embed UnimplementedAuthProviderServer for forward compatibility

type CommHealth

type CommHealth struct {
	Status types.CommStatus `protobuf:"varint,1,opt,name=status,proto3,enum=smartcore.types.CommStatus" json:"status,omitempty"`
	// The most recent time the status changed to COMM_FAILURE
	FailureTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=failure_time,json=failureTime,proto3" json:"failure_time,omitempty"`
	// The most recent time the status changed to COMM_SUCCESS
	SuccessTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=success_time,json=successTime,proto3" json:"success_time,omitempty"`
	// contains filtered or unexported fields
}

Describes the health of communication.

func (*CommHealth) Descriptor deprecated

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

Deprecated: Use CommHealth.ProtoReflect.Descriptor instead.

func (*CommHealth) GetFailureTime

func (x *CommHealth) GetFailureTime() *timestamppb.Timestamp

func (*CommHealth) GetStatus

func (x *CommHealth) GetStatus() types.CommStatus

func (*CommHealth) GetSuccessTime

func (x *CommHealth) GetSuccessTime() *timestamppb.Timestamp

func (*CommHealth) ProtoMessage

func (*CommHealth) ProtoMessage()

func (*CommHealth) ProtoReflect

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

func (*CommHealth) Reset

func (x *CommHealth) Reset()

func (*CommHealth) String

func (x *CommHealth) String() string

type ConnectionHealth

type ConnectionHealth struct {

	// are we currently connected
	Status types.Connectivity `protobuf:"varint,1,opt,name=status,proto3,enum=smartcore.types.Connectivity" json:"status,omitempty"`
	// When was the last time a successful connection was established
	ConnectTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=connect_time,json=connectTime,proto3" json:"connect_time,omitempty"`
	// When was the last time a connection was closed/ended
	DisconnectTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=disconnect_time,json=disconnectTime,proto3" json:"disconnect_time,omitempty"`
	// contains filtered or unexported fields
}

Describes the health of a connection

func (*ConnectionHealth) Descriptor deprecated

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

Deprecated: Use ConnectionHealth.ProtoReflect.Descriptor instead.

func (*ConnectionHealth) GetConnectTime

func (x *ConnectionHealth) GetConnectTime() *timestamppb.Timestamp

func (*ConnectionHealth) GetDisconnectTime

func (x *ConnectionHealth) GetDisconnectTime() *timestamppb.Timestamp

func (*ConnectionHealth) GetStatus

func (x *ConnectionHealth) GetStatus() types.Connectivity

func (*ConnectionHealth) ProtoMessage

func (*ConnectionHealth) ProtoMessage()

func (*ConnectionHealth) ProtoReflect

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

func (*ConnectionHealth) Reset

func (x *ConnectionHealth) Reset()

func (*ConnectionHealth) String

func (x *ConnectionHealth) String() string

type Device

type Device struct {

	// the relative resource name for the device
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// List of traits the device has.
	Traits []*Trait `protobuf:"bytes,2,rep,name=traits,proto3" json:"traits,omitempty"`
	// Owner of the device. This is the the device, supervisor, or area controller that is directly responsible for
	// communication with the device, i.e. service requests should go through the owner.
	Owner *Device `protobuf:"bytes,3,opt,name=owner,proto3" json:"owner,omitempty"`
	// Information used to connect to the device directly via gRPC. This must not be present if we are supposed to connect
	// via the owner device. This may be present if direct communication is possible, even if owner is also set. Prefer
	// Connecting via owner if possible.
	Client *GrpcClientOptions `protobuf:"bytes,4,opt,name=client,proto3" json:"client,omitempty"`
	// Official name for the device
	Title string `protobuf:"bytes,5,opt,name=title,proto3" json:"title,omitempty"`
	// Readable name for the device
	DisplayName string `protobuf:"bytes,6,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// One or more paragraphs of text describing the device
	Description string `protobuf:"bytes,7,opt,name=description,proto3" json:"description,omitempty"`
	// arbitrary flags that can be applied to the device to encode additional information
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes basic information about a device. Device hierarchy is loosely defined via the owner property

func (*Device) Descriptor deprecated

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

Deprecated: Use Device.ProtoReflect.Descriptor instead.

func (*Device) GetClient

func (x *Device) GetClient() *GrpcClientOptions

func (*Device) GetDescription

func (x *Device) GetDescription() string

func (*Device) GetDisplayName

func (x *Device) GetDisplayName() string

func (*Device) GetLabels

func (x *Device) GetLabels() map[string]string

func (*Device) GetName

func (x *Device) GetName() string

func (*Device) GetOwner

func (x *Device) GetOwner() *Device

func (*Device) GetTitle

func (x *Device) GetTitle() string

func (*Device) GetTraits

func (x *Device) GetTraits() []*Trait

func (*Device) ProtoMessage

func (*Device) ProtoMessage()

func (*Device) ProtoReflect

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

func (*Device) Reset

func (x *Device) Reset()

func (*Device) String

func (x *Device) String() string

type GenerateTokenRequest

type GenerateTokenRequest struct {
	AccountName string `protobuf:"bytes,1,opt,name=account_name,json=accountName,proto3" json:"account_name,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateTokenRequest) Descriptor deprecated

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

Deprecated: Use GenerateTokenRequest.ProtoReflect.Descriptor instead.

func (*GenerateTokenRequest) GetAccountName

func (x *GenerateTokenRequest) GetAccountName() string

func (*GenerateTokenRequest) ProtoMessage

func (*GenerateTokenRequest) ProtoMessage()

func (*GenerateTokenRequest) ProtoReflect

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

func (*GenerateTokenRequest) Reset

func (x *GenerateTokenRequest) Reset()

func (*GenerateTokenRequest) String

func (x *GenerateTokenRequest) String() string

type GenerateTokenResponse

type GenerateTokenResponse struct {
	Token *Token `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateTokenResponse) Descriptor deprecated

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

Deprecated: Use GenerateTokenResponse.ProtoReflect.Descriptor instead.

func (*GenerateTokenResponse) GetToken

func (x *GenerateTokenResponse) GetToken() *Token

func (*GenerateTokenResponse) ProtoMessage

func (*GenerateTokenResponse) ProtoMessage()

func (*GenerateTokenResponse) ProtoReflect

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

func (*GenerateTokenResponse) Reset

func (x *GenerateTokenResponse) Reset()

func (*GenerateTokenResponse) String

func (x *GenerateTokenResponse) String() string

type GetHealthStateRequest

type GetHealthStateRequest struct {

	// Name of the device to query the health state for
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetHealthStateRequest) Descriptor deprecated

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

Deprecated: Use GetHealthStateRequest.ProtoReflect.Descriptor instead.

func (*GetHealthStateRequest) GetName

func (x *GetHealthStateRequest) GetName() string

func (*GetHealthStateRequest) ProtoMessage

func (*GetHealthStateRequest) ProtoMessage()

func (*GetHealthStateRequest) ProtoReflect

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

func (*GetHealthStateRequest) Reset

func (x *GetHealthStateRequest) Reset()

func (*GetHealthStateRequest) String

func (x *GetHealthStateRequest) String() string

type GrpcClientOptions

type GrpcClientOptions struct {

	// The host:port for the server
	Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
	// PEM encoded client certificate for use with gRPC transport security
	ClientCert []byte `protobuf:"bytes,2,opt,name=clientCert,proto3" json:"clientCert,omitempty"`
	// PEM encoded client private key for use with gRPC transport security
	ClientKey []byte `protobuf:"bytes,3,opt,name=clientKey,proto3" json:"clientKey,omitempty"`
	// PEM encoded certificate chan representing the certificate authority for use with gRPC transport security
	ClientCa []byte `protobuf:"bytes,4,opt,name=clientCa,proto3" json:"clientCa,omitempty"`
	// contains filtered or unexported fields
}

describes options relating to client connections

func (*GrpcClientOptions) Descriptor deprecated

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

Deprecated: Use GrpcClientOptions.ProtoReflect.Descriptor instead.

func (*GrpcClientOptions) GetAuthority

func (x *GrpcClientOptions) GetAuthority() string

func (*GrpcClientOptions) GetClientCa

func (x *GrpcClientOptions) GetClientCa() []byte

func (*GrpcClientOptions) GetClientCert

func (x *GrpcClientOptions) GetClientCert() []byte

func (*GrpcClientOptions) GetClientKey

func (x *GrpcClientOptions) GetClientKey() []byte

func (*GrpcClientOptions) ProtoMessage

func (*GrpcClientOptions) ProtoMessage()

func (*GrpcClientOptions) ProtoReflect

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

func (*GrpcClientOptions) Reset

func (x *GrpcClientOptions) Reset()

func (*GrpcClientOptions) String

func (x *GrpcClientOptions) String() string

type HealthClient

type HealthClient interface {
	GetHealthState(ctx context.Context, in *GetHealthStateRequest, opts ...grpc.CallOption) (*HealthState, error)
	PullHealthStates(ctx context.Context, in *PullHealthStatesRequest, opts ...grpc.CallOption) (Health_PullHealthStatesClient, error)
}

HealthClient is the client API for Health 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.

func NewHealthClient

func NewHealthClient(cc grpc.ClientConnInterface) HealthClient

type HealthServer

type HealthServer interface {
	GetHealthState(context.Context, *GetHealthStateRequest) (*HealthState, error)
	PullHealthStates(*PullHealthStatesRequest, Health_PullHealthStatesServer) error
	// contains filtered or unexported methods
}

HealthServer is the server API for Health service. All implementations must embed UnimplementedHealthServer for forward compatibility

type HealthState

type HealthState struct {

	// Health of the connection to the physical device
	Connection *ConnectionHealth `protobuf:"bytes,1,opt,name=connection,proto3" json:"connection,omitempty"`
	// Health of communication with the device
	Comm *CommHealth `protobuf:"bytes,2,opt,name=comm,proto3" json:"comm,omitempty"`
	// contains filtered or unexported fields
}

func (*HealthState) Descriptor deprecated

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

Deprecated: Use HealthState.ProtoReflect.Descriptor instead.

func (*HealthState) GetComm

func (x *HealthState) GetComm() *CommHealth

func (*HealthState) GetConnection

func (x *HealthState) GetConnection() *ConnectionHealth

func (*HealthState) ProtoMessage

func (*HealthState) ProtoMessage()

func (*HealthState) ProtoReflect

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

func (*HealthState) Reset

func (x *HealthState) Reset()

func (*HealthState) String

func (x *HealthState) String() string

type HealthStateChange

type HealthStateChange struct {

	// The name of the device that is the source of the change
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// When the change was applied
	ChangeTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=change_time,json=changeTime,proto3" json:"change_time,omitempty"`
	// The new state for the change
	Health *HealthState `protobuf:"bytes,3,opt,name=health,proto3" json:"health,omitempty"`
	// contains filtered or unexported fields
}

func (*HealthStateChange) Descriptor deprecated

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

Deprecated: Use HealthStateChange.ProtoReflect.Descriptor instead.

func (*HealthStateChange) GetChangeTime

func (x *HealthStateChange) GetChangeTime() *timestamppb.Timestamp

func (*HealthStateChange) GetHealth

func (x *HealthStateChange) GetHealth() *HealthState

func (*HealthStateChange) GetName

func (x *HealthStateChange) GetName() string

func (*HealthStateChange) ProtoMessage

func (*HealthStateChange) ProtoMessage()

func (*HealthStateChange) ProtoReflect

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

func (*HealthStateChange) Reset

func (x *HealthStateChange) Reset()

func (*HealthStateChange) String

func (x *HealthStateChange) String() string

type Health_PullHealthStatesClient

type Health_PullHealthStatesClient interface {
	Recv() (*PullHealthStatesResponse, error)
	grpc.ClientStream
}

type Health_PullHealthStatesServer

type Health_PullHealthStatesServer interface {
	Send(*PullHealthStatesResponse) error
	grpc.ServerStream
}

type InfoClient

type InfoClient interface {
	// Get devices that this service knows about
	ListDevices(ctx context.Context, in *ListDevicesRequest, opts ...grpc.CallOption) (*ListDevicesResponse, error)
	// Open a server stream that responds with changes to the set of devices described in the request
	PullDevices(ctx context.Context, in *PullDevicesRequest, opts ...grpc.CallOption) (Info_PullDevicesClient, error)
}

InfoClient is the client API for Info 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.

func NewInfoClient

func NewInfoClient(cc grpc.ClientConnInterface) InfoClient

type InfoServer

type InfoServer interface {
	// Get devices that this service knows about
	ListDevices(context.Context, *ListDevicesRequest) (*ListDevicesResponse, error)
	// Open a server stream that responds with changes to the set of devices described in the request
	PullDevices(*PullDevicesRequest, Info_PullDevicesServer) error
	// contains filtered or unexported methods
}

InfoServer is the server API for Info service. All implementations must embed UnimplementedInfoServer for forward compatibility

type Info_PullDevicesClient

type Info_PullDevicesClient interface {
	Recv() (*PullDevicesResponse, error)
	grpc.ClientStream
}

type Info_PullDevicesServer

type Info_PullDevicesServer interface {
	Send(*PullDevicesResponse) error
	grpc.ServerStream
}

type ListDevicesRequest

type ListDevicesRequest struct {

	// Only return devices this deep in the device -> device -> device tree. Default is unlimited depth, 1 means only
	// return devices owned by the enclosing service.
	Depth int32 `protobuf:"varint,1,opt,name=depth,proto3" json:"depth,omitempty"`
	// How many items should be returned. Default is 10, max is 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The next_page_token from the previous response
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListDevicesRequest) Descriptor deprecated

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

Deprecated: Use ListDevicesRequest.ProtoReflect.Descriptor instead.

func (*ListDevicesRequest) GetDepth

func (x *ListDevicesRequest) GetDepth() int32

func (*ListDevicesRequest) GetPageSize

func (x *ListDevicesRequest) GetPageSize() int32

func (*ListDevicesRequest) GetPageToken

func (x *ListDevicesRequest) GetPageToken() string

func (*ListDevicesRequest) ProtoMessage

func (*ListDevicesRequest) ProtoMessage()

func (*ListDevicesRequest) ProtoReflect

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

func (*ListDevicesRequest) Reset

func (x *ListDevicesRequest) Reset()

func (*ListDevicesRequest) String

func (x *ListDevicesRequest) String() string

type ListDevicesResponse

type ListDevicesResponse struct {

	// The current page of devices to satisfy the request
	Devices []*Device `protobuf:"bytes,1,rep,name=devices,proto3" json:"devices,omitempty"`
	// Use in page_token to retrieve the next page
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Total number of devices that would be returned if not splitting the response into pages.
	TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
	// contains filtered or unexported fields
}

func (*ListDevicesResponse) Descriptor deprecated

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

Deprecated: Use ListDevicesResponse.ProtoReflect.Descriptor instead.

func (*ListDevicesResponse) GetDevices

func (x *ListDevicesResponse) GetDevices() []*Device

func (*ListDevicesResponse) GetNextPageToken

func (x *ListDevicesResponse) GetNextPageToken() string

func (*ListDevicesResponse) GetTotalSize

func (x *ListDevicesResponse) GetTotalSize() int32

func (*ListDevicesResponse) ProtoMessage

func (*ListDevicesResponse) ProtoMessage()

func (*ListDevicesResponse) ProtoReflect

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

func (*ListDevicesResponse) Reset

func (x *ListDevicesResponse) Reset()

func (*ListDevicesResponse) String

func (x *ListDevicesResponse) String() string

type Permission

type Permission struct {

	// The fully qualified name of the device this permission represents, or '*' for all devices
	DeviceName string `protobuf:"bytes,1,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// The fully qualified name of the trait on the specified device this permission represents (in package.Service format), or '*' for all traits
	TraitName string `protobuf:"bytes,2,opt,name=trait_name,json=traitName,proto3" json:"trait_name,omitempty"`
	// Whether to allow read calls for this device-trait
	Read bool `protobuf:"varint,3,opt,name=read,proto3" json:"read,omitempty"`
	// Whether to allow write calls for this device-trait
	Write bool `protobuf:"varint,4,opt,name=write,proto3" json:"write,omitempty"`
	// Whether to allow observe calls (i.e. Pull requests) for this device-trait
	Observe bool `protobuf:"varint,5,opt,name=observe,proto3" json:"observe,omitempty"`
	// contains filtered or unexported fields
}

Describes a permission level for a particular device-trait

func (*Permission) Descriptor deprecated

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

Deprecated: Use Permission.ProtoReflect.Descriptor instead.

func (*Permission) GetDeviceName

func (x *Permission) GetDeviceName() string

func (*Permission) GetObserve

func (x *Permission) GetObserve() bool

func (*Permission) GetRead

func (x *Permission) GetRead() bool

func (*Permission) GetTraitName

func (x *Permission) GetTraitName() string

func (*Permission) GetWrite

func (x *Permission) GetWrite() bool

func (*Permission) ProtoMessage

func (*Permission) ProtoMessage()

func (*Permission) ProtoReflect

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

func (*Permission) Reset

func (x *Permission) Reset()

func (*Permission) String

func (x *Permission) String() string

type PullDevicesRequest

type PullDevicesRequest struct {

	// Only return devices this deep in the device -> device -> device tree. Default is unlimited depth, 1 means only
	// return devices owned by the enclosing service.
	Depth int32 `protobuf:"varint,1,opt,name=depth,proto3" json:"depth,omitempty"`
	// if true, all existing devices will be sent down the stream before any updates.
	Sync bool `protobuf:"varint,2,opt,name=sync,proto3" json:"sync,omitempty"`
	// contains filtered or unexported fields
}

func (*PullDevicesRequest) Descriptor deprecated

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

Deprecated: Use PullDevicesRequest.ProtoReflect.Descriptor instead.

func (*PullDevicesRequest) GetDepth

func (x *PullDevicesRequest) GetDepth() int32

func (*PullDevicesRequest) GetSync

func (x *PullDevicesRequest) GetSync() bool

func (*PullDevicesRequest) ProtoMessage

func (*PullDevicesRequest) ProtoMessage()

func (*PullDevicesRequest) ProtoReflect

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

func (*PullDevicesRequest) Reset

func (x *PullDevicesRequest) Reset()

func (*PullDevicesRequest) String

func (x *PullDevicesRequest) String() string

type PullDevicesResponse

type PullDevicesResponse struct {
	Changes []*PullDevicesResponse_Change `protobuf:"bytes,1,rep,name=changes,proto3" json:"changes,omitempty"`
	// contains filtered or unexported fields
}

func (*PullDevicesResponse) Descriptor deprecated

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

Deprecated: Use PullDevicesResponse.ProtoReflect.Descriptor instead.

func (*PullDevicesResponse) GetChanges

func (*PullDevicesResponse) ProtoMessage

func (*PullDevicesResponse) ProtoMessage()

func (*PullDevicesResponse) ProtoReflect

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

func (*PullDevicesResponse) Reset

func (x *PullDevicesResponse) Reset()

func (*PullDevicesResponse) String

func (x *PullDevicesResponse) String() string

type PullDevicesResponse_Change

type PullDevicesResponse_Change struct {
	Type     types.ChangeType `protobuf:"varint,1,opt,name=type,proto3,enum=smartcore.types.ChangeType" json:"type,omitempty"`
	NewValue *Device          `protobuf:"bytes,2,opt,name=new_value,json=newValue,proto3" json:"new_value,omitempty"`
	OldValue *Device          `protobuf:"bytes,3,opt,name=old_value,json=oldValue,proto3" json:"old_value,omitempty"`
	// contains filtered or unexported fields
}

func (*PullDevicesResponse_Change) Descriptor deprecated

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

Deprecated: Use PullDevicesResponse_Change.ProtoReflect.Descriptor instead.

func (*PullDevicesResponse_Change) GetNewValue

func (x *PullDevicesResponse_Change) GetNewValue() *Device

func (*PullDevicesResponse_Change) GetOldValue

func (x *PullDevicesResponse_Change) GetOldValue() *Device

func (*PullDevicesResponse_Change) GetType

func (*PullDevicesResponse_Change) ProtoMessage

func (*PullDevicesResponse_Change) ProtoMessage()

func (*PullDevicesResponse_Change) ProtoReflect

func (*PullDevicesResponse_Change) Reset

func (x *PullDevicesResponse_Change) Reset()

func (*PullDevicesResponse_Change) String

func (x *PullDevicesResponse_Change) String() string

type PullHealthStatesRequest

type PullHealthStatesRequest struct {

	// Name of the device to subscribe to the health state for
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*PullHealthStatesRequest) Descriptor deprecated

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

Deprecated: Use PullHealthStatesRequest.ProtoReflect.Descriptor instead.

func (*PullHealthStatesRequest) GetName

func (x *PullHealthStatesRequest) GetName() string

func (*PullHealthStatesRequest) ProtoMessage

func (*PullHealthStatesRequest) ProtoMessage()

func (*PullHealthStatesRequest) ProtoReflect

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

func (*PullHealthStatesRequest) Reset

func (x *PullHealthStatesRequest) Reset()

func (*PullHealthStatesRequest) String

func (x *PullHealthStatesRequest) String() string

type PullHealthStatesResponse

type PullHealthStatesResponse struct {
	Changes []*HealthStateChange `protobuf:"bytes,1,rep,name=changes,proto3" json:"changes,omitempty"`
	// contains filtered or unexported fields
}

func (*PullHealthStatesResponse) Descriptor deprecated

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

Deprecated: Use PullHealthStatesResponse.ProtoReflect.Descriptor instead.

func (*PullHealthStatesResponse) GetChanges

func (x *PullHealthStatesResponse) GetChanges() []*HealthStateChange

func (*PullHealthStatesResponse) ProtoMessage

func (*PullHealthStatesResponse) ProtoMessage()

func (*PullHealthStatesResponse) ProtoReflect

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

func (*PullHealthStatesResponse) Reset

func (x *PullHealthStatesResponse) Reset()

func (*PullHealthStatesResponse) String

func (x *PullHealthStatesResponse) String() string

type RemoveAccountRequest

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

func (*RemoveAccountRequest) Descriptor deprecated

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

Deprecated: Use RemoveAccountRequest.ProtoReflect.Descriptor instead.

func (*RemoveAccountRequest) GetName

func (x *RemoveAccountRequest) GetName() string

func (*RemoveAccountRequest) ProtoMessage

func (*RemoveAccountRequest) ProtoMessage()

func (*RemoveAccountRequest) ProtoReflect

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

func (*RemoveAccountRequest) Reset

func (x *RemoveAccountRequest) Reset()

func (*RemoveAccountRequest) String

func (x *RemoveAccountRequest) String() string

type RemoveAccountResponse

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

func (*RemoveAccountResponse) Descriptor deprecated

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

Deprecated: Use RemoveAccountResponse.ProtoReflect.Descriptor instead.

func (*RemoveAccountResponse) ProtoMessage

func (*RemoveAccountResponse) ProtoMessage()

func (*RemoveAccountResponse) ProtoReflect

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

func (*RemoveAccountResponse) Reset

func (x *RemoveAccountResponse) Reset()

func (*RemoveAccountResponse) String

func (x *RemoveAccountResponse) String() string

type Token

type Token struct {

	// The token ID string
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// A time the token expires
	ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	// contains filtered or unexported fields
}

Represents a token that can be granted against an Account for

func (*Token) Descriptor deprecated

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

Deprecated: Use Token.ProtoReflect.Descriptor instead.

func (*Token) GetExpiresAt

func (x *Token) GetExpiresAt() *timestamppb.Timestamp

func (*Token) GetId

func (x *Token) GetId() string

func (*Token) ProtoMessage

func (*Token) ProtoMessage()

func (*Token) ProtoReflect

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

func (*Token) Reset

func (x *Token) Reset()

func (*Token) String

func (x *Token) String() string

type Trait

type Trait struct {

	// Name of the trait service that is implemented. In the format package.Service excluding Api or other type suffix.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

describes a trait for the api. See the devices/traits apis for details of these.

func (*Trait) Descriptor deprecated

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

Deprecated: Use Trait.ProtoReflect.Descriptor instead.

func (*Trait) GetName

func (x *Trait) GetName() string

func (*Trait) ProtoMessage

func (*Trait) ProtoMessage()

func (*Trait) ProtoReflect

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

func (*Trait) Reset

func (x *Trait) Reset()

func (*Trait) String

func (x *Trait) String() string

type UnimplementedAuthProviderServer

type UnimplementedAuthProviderServer struct {
}

UnimplementedAuthProviderServer must be embedded to have forward compatible implementations.

func (UnimplementedAuthProviderServer) AddAccount

func (UnimplementedAuthProviderServer) GenerateToken

func (UnimplementedAuthProviderServer) RemoveAccount

type UnimplementedHealthServer

type UnimplementedHealthServer struct {
}

UnimplementedHealthServer must be embedded to have forward compatible implementations.

func (UnimplementedHealthServer) GetHealthState

func (UnimplementedHealthServer) PullHealthStates

type UnimplementedInfoServer

type UnimplementedInfoServer struct {
}

UnimplementedInfoServer must be embedded to have forward compatible implementations.

func (UnimplementedInfoServer) ListDevices

func (UnimplementedInfoServer) PullDevices

type UnsafeAuthProviderServer

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

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

type UnsafeHealthServer

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

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

type UnsafeInfoServer

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

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

type UpdateAccountPermissionsRequest

type UpdateAccountPermissionsRequest struct {
	ChangeType  types.ChangeType `protobuf:"varint,1,opt,name=change_type,json=changeType,proto3,enum=smartcore.types.ChangeType" json:"change_type,omitempty"`
	Permissions []*Permission    `protobuf:"bytes,2,rep,name=permissions,proto3" json:"permissions,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateAccountPermissionsRequest) Descriptor deprecated

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

Deprecated: Use UpdateAccountPermissionsRequest.ProtoReflect.Descriptor instead.

func (*UpdateAccountPermissionsRequest) GetChangeType

func (*UpdateAccountPermissionsRequest) GetPermissions

func (x *UpdateAccountPermissionsRequest) GetPermissions() []*Permission

func (*UpdateAccountPermissionsRequest) ProtoMessage

func (*UpdateAccountPermissionsRequest) ProtoMessage()

func (*UpdateAccountPermissionsRequest) ProtoReflect

func (*UpdateAccountPermissionsRequest) Reset

func (*UpdateAccountPermissionsRequest) String

type UpdateAccountPermissionsResponse

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

func (*UpdateAccountPermissionsResponse) Descriptor deprecated

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

Deprecated: Use UpdateAccountPermissionsResponse.ProtoReflect.Descriptor instead.

func (*UpdateAccountPermissionsResponse) ProtoMessage

func (*UpdateAccountPermissionsResponse) ProtoMessage()

func (*UpdateAccountPermissionsResponse) ProtoReflect

func (*UpdateAccountPermissionsResponse) Reset

func (*UpdateAccountPermissionsResponse) String

Jump to

Keyboard shortcuts

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