var File_google_home_enterprise_sdm_v1_device_proto protoreflect.FileDescriptor
var File_google_home_enterprise_sdm_v1_site_proto protoreflect.FileDescriptor
var File_google_home_enterprise_sdm_v1_smart_device_management_service_proto protoreflect.FileDescriptor
func RegisterSmartDeviceManagementServiceServer(s *grpc.Server, srv SmartDeviceManagementServiceServer)
Device resource represents an instance of enterprise managed device in the property.
type Device struct {
// Required. The resource name of the device. For example:
// "enterprises/XYZ/devices/123".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. Type of the device for general display purposes.
// For example: "THERMOSTAT". The device type should not be used to deduce or
// infer functionality of the actual device it is assigned to. Instead, use
// the returned traits for the device.
Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
// Output only. Device traits.
Traits *structpb.Struct `protobuf:"bytes,4,opt,name=traits,proto3" json:"traits,omitempty"`
// Assignee details of the device.
ParentRelations []*ParentRelation `protobuf:"bytes,5,rep,name=parent_relations,json=parentRelations,proto3" json:"parent_relations,omitempty"`
// contains filtered or unexported fields
}
func (*Device) Descriptor() ([]byte, []int)
Deprecated: Use Device.ProtoReflect.Descriptor instead.
func (x *Device) GetName() string
func (x *Device) GetParentRelations() []*ParentRelation
func (x *Device) GetTraits() *structpb.Struct
func (x *Device) GetType() string
func (*Device) ProtoMessage()
func (x *Device) ProtoReflect() protoreflect.Message
func (x *Device) Reset()
func (x *Device) String() string
Request message for SmartDeviceManagementService.ExecuteDeviceCommand
type ExecuteDeviceCommandRequest struct {
// The name of the device requested. For example:
// "enterprises/XYZ/devices/123"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The command name to execute, represented by the fully qualified protobuf
// message name.
Command string `protobuf:"bytes,2,opt,name=command,proto3" json:"command,omitempty"`
// The command message to execute, represented as a Struct.
Params *structpb.Struct `protobuf:"bytes,3,opt,name=params,proto3" json:"params,omitempty"`
// contains filtered or unexported fields
}
func (*ExecuteDeviceCommandRequest) Descriptor() ([]byte, []int)
Deprecated: Use ExecuteDeviceCommandRequest.ProtoReflect.Descriptor instead.
func (x *ExecuteDeviceCommandRequest) GetCommand() string
func (x *ExecuteDeviceCommandRequest) GetName() string
func (x *ExecuteDeviceCommandRequest) GetParams() *structpb.Struct
func (*ExecuteDeviceCommandRequest) ProtoMessage()
func (x *ExecuteDeviceCommandRequest) ProtoReflect() protoreflect.Message
func (x *ExecuteDeviceCommandRequest) Reset()
func (x *ExecuteDeviceCommandRequest) String() string
Response message for SmartDeviceManagementService.ExecuteDeviceCommand
type ExecuteDeviceCommandResponse struct {
// The results of executing the command.
Results *structpb.Struct `protobuf:"bytes,1,opt,name=results,proto3" json:"results,omitempty"`
// contains filtered or unexported fields
}
func (*ExecuteDeviceCommandResponse) Descriptor() ([]byte, []int)
Deprecated: Use ExecuteDeviceCommandResponse.ProtoReflect.Descriptor instead.
func (x *ExecuteDeviceCommandResponse) GetResults() *structpb.Struct
func (*ExecuteDeviceCommandResponse) ProtoMessage()
func (x *ExecuteDeviceCommandResponse) ProtoReflect() protoreflect.Message
func (x *ExecuteDeviceCommandResponse) Reset()
func (x *ExecuteDeviceCommandResponse) String() string
Request message for SmartDeviceManagementService.GetDevice
type GetDeviceRequest struct {
// The name of the device requested. For example:
// "enterprises/XYZ/devices/123"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetDeviceRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDeviceRequest.ProtoReflect.Descriptor instead.
func (x *GetDeviceRequest) GetName() string
func (*GetDeviceRequest) ProtoMessage()
func (x *GetDeviceRequest) ProtoReflect() protoreflect.Message
func (x *GetDeviceRequest) Reset()
func (x *GetDeviceRequest) String() string
Request message for SmartDeviceManagementService.GetRoom
type GetRoomRequest struct {
// The name of the room requested. For example:
// "enterprises/XYZ/structures/ABC/rooms/123".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetRoomRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetRoomRequest.ProtoReflect.Descriptor instead.
func (x *GetRoomRequest) GetName() string
func (*GetRoomRequest) ProtoMessage()
func (x *GetRoomRequest) ProtoReflect() protoreflect.Message
func (x *GetRoomRequest) Reset()
func (x *GetRoomRequest) String() string
Request message for SmartDeviceManagementService.GetStructure
type GetStructureRequest struct {
// The name of the structure requested. For example:
// "enterprises/XYZ/structures/ABC".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetStructureRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetStructureRequest.ProtoReflect.Descriptor instead.
func (x *GetStructureRequest) GetName() string
func (*GetStructureRequest) ProtoMessage()
func (x *GetStructureRequest) ProtoReflect() protoreflect.Message
func (x *GetStructureRequest) Reset()
func (x *GetStructureRequest) String() string
Request message for SmartDeviceManagementService.ListDevices
type ListDevicesRequest struct {
// The parent enterprise to list devices under. E.g. "enterprises/XYZ".
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional requested page size. Server may return fewer devices than
// requested. If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional token of the page to retrieve.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional filter to list devices.
//
// Filters can be done on:
// Device custom name (substring match):
// 'customName=wing'
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}
func (*ListDevicesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListDevicesRequest.ProtoReflect.Descriptor instead.
func (x *ListDevicesRequest) GetFilter() string
func (x *ListDevicesRequest) GetPageSize() int32
func (x *ListDevicesRequest) GetPageToken() string
func (x *ListDevicesRequest) GetParent() string
func (*ListDevicesRequest) ProtoMessage()
func (x *ListDevicesRequest) ProtoReflect() protoreflect.Message
func (x *ListDevicesRequest) Reset()
func (x *ListDevicesRequest) String() string
Response message for SmartDeviceManagementService.ListDevices
type ListDevicesResponse struct {
// The list of devices.
Devices []*Device `protobuf:"bytes,1,rep,name=devices,proto3" json:"devices,omitempty"`
// The pagination token to retrieve the next page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListDevicesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListDevicesResponse.ProtoReflect.Descriptor instead.
func (x *ListDevicesResponse) GetDevices() []*Device
func (x *ListDevicesResponse) GetNextPageToken() string
func (*ListDevicesResponse) ProtoMessage()
func (x *ListDevicesResponse) ProtoReflect() protoreflect.Message
func (x *ListDevicesResponse) Reset()
func (x *ListDevicesResponse) String() string
Request message for SmartDeviceManagementService.ListRooms
type ListRoomsRequest struct {
// The parent resource name of the rooms requested. For example:
// "enterprises/XYZ/structures/ABC".
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Requested page size. Server may return fewer rooms than requested.
// If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The token of the page to retrieve.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListRoomsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListRoomsRequest.ProtoReflect.Descriptor instead.
func (x *ListRoomsRequest) GetPageSize() int32
func (x *ListRoomsRequest) GetPageToken() string
func (x *ListRoomsRequest) GetParent() string
func (*ListRoomsRequest) ProtoMessage()
func (x *ListRoomsRequest) ProtoReflect() protoreflect.Message
func (x *ListRoomsRequest) Reset()
func (x *ListRoomsRequest) String() string
Response message for SmartDeviceManagementService.ListRooms
type ListRoomsResponse struct {
// The list of rooms.
Rooms []*Room `protobuf:"bytes,1,rep,name=rooms,proto3" json:"rooms,omitempty"`
// The pagination token to retrieve the next page of results.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListRoomsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListRoomsResponse.ProtoReflect.Descriptor instead.
func (x *ListRoomsResponse) GetNextPageToken() string
func (x *ListRoomsResponse) GetRooms() []*Room
func (*ListRoomsResponse) ProtoMessage()
func (x *ListRoomsResponse) ProtoReflect() protoreflect.Message
func (x *ListRoomsResponse) Reset()
func (x *ListRoomsResponse) String() string
Request message for SmartDeviceManagementService.ListStructures
type ListStructuresRequest struct {
// The parent enterprise to list structures under. E.g. "enterprises/XYZ".
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Requested page size. Server may return fewer structures than requested.
// If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The token of the page to retrieve.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional filter to list structures.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}
func (*ListStructuresRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListStructuresRequest.ProtoReflect.Descriptor instead.
func (x *ListStructuresRequest) GetFilter() string
func (x *ListStructuresRequest) GetPageSize() int32
func (x *ListStructuresRequest) GetPageToken() string
func (x *ListStructuresRequest) GetParent() string
func (*ListStructuresRequest) ProtoMessage()
func (x *ListStructuresRequest) ProtoReflect() protoreflect.Message
func (x *ListStructuresRequest) Reset()
func (x *ListStructuresRequest) String() string
Response message for SmartDeviceManagementService.ListStructures
type ListStructuresResponse struct {
// The list of structures.
Structures []*Structure `protobuf:"bytes,1,rep,name=structures,proto3" json:"structures,omitempty"`
// The pagination token to retrieve the next page of results.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListStructuresResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListStructuresResponse.ProtoReflect.Descriptor instead.
func (x *ListStructuresResponse) GetNextPageToken() string
func (x *ListStructuresResponse) GetStructures() []*Structure
func (*ListStructuresResponse) ProtoMessage()
func (x *ListStructuresResponse) ProtoReflect() protoreflect.Message
func (x *ListStructuresResponse) Reset()
func (x *ListStructuresResponse) String() string
Represents device relationships, for instance, structure/room to which the device is assigned to.
type ParentRelation struct {
// Output only. The name of the relation -- e.g., structure/room where the
// device is assigned to. For example: "enterprises/XYZ/structures/ABC" or
// "enterprises/XYZ/structures/ABC/rooms/123"
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Output only. The custom name of the relation -- e.g., structure/room where
// the device is assigned to.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// contains filtered or unexported fields
}
func (*ParentRelation) Descriptor() ([]byte, []int)
Deprecated: Use ParentRelation.ProtoReflect.Descriptor instead.
func (x *ParentRelation) GetDisplayName() string
func (x *ParentRelation) GetParent() string
func (*ParentRelation) ProtoMessage()
func (x *ParentRelation) ProtoReflect() protoreflect.Message
func (x *ParentRelation) Reset()
func (x *ParentRelation) String() string
Room resource represents an instance of sub-space within a structure such as rooms in a hotel suite or rental apartment.
type Room struct {
// Output only. The resource name of the room. For example:
// "enterprises/XYZ/structures/ABC/rooms/123".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Room traits.
Traits *structpb.Struct `protobuf:"bytes,2,opt,name=traits,proto3" json:"traits,omitempty"`
// contains filtered or unexported fields
}
func (*Room) Descriptor() ([]byte, []int)
Deprecated: Use Room.ProtoReflect.Descriptor instead.
func (x *Room) GetName() string
func (x *Room) GetTraits() *structpb.Struct
func (*Room) ProtoMessage()
func (x *Room) ProtoReflect() protoreflect.Message
func (x *Room) Reset()
func (x *Room) String() string
SmartDeviceManagementServiceClient is the client API for SmartDeviceManagementService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type SmartDeviceManagementServiceClient interface {
// Gets a device managed by the enterprise.
GetDevice(ctx context.Context, in *GetDeviceRequest, opts ...grpc.CallOption) (*Device, error)
// Lists devices managed by the enterprise.
ListDevices(ctx context.Context, in *ListDevicesRequest, opts ...grpc.CallOption) (*ListDevicesResponse, error)
// Executes a command to device managed by the enterprise.
ExecuteDeviceCommand(ctx context.Context, in *ExecuteDeviceCommandRequest, opts ...grpc.CallOption) (*ExecuteDeviceCommandResponse, error)
// Gets a structure managed by the enterprise.
GetStructure(ctx context.Context, in *GetStructureRequest, opts ...grpc.CallOption) (*Structure, error)
// Lists structures managed by the enterprise.
ListStructures(ctx context.Context, in *ListStructuresRequest, opts ...grpc.CallOption) (*ListStructuresResponse, error)
// Gets a room managed by the enterprise.
GetRoom(ctx context.Context, in *GetRoomRequest, opts ...grpc.CallOption) (*Room, error)
// Lists rooms managed by the enterprise.
ListRooms(ctx context.Context, in *ListRoomsRequest, opts ...grpc.CallOption) (*ListRoomsResponse, error)
}
func NewSmartDeviceManagementServiceClient(cc grpc.ClientConnInterface) SmartDeviceManagementServiceClient
SmartDeviceManagementServiceServer is the server API for SmartDeviceManagementService service.
type SmartDeviceManagementServiceServer interface {
// Gets a device managed by the enterprise.
GetDevice(context.Context, *GetDeviceRequest) (*Device, error)
// Lists devices managed by the enterprise.
ListDevices(context.Context, *ListDevicesRequest) (*ListDevicesResponse, error)
// Executes a command to device managed by the enterprise.
ExecuteDeviceCommand(context.Context, *ExecuteDeviceCommandRequest) (*ExecuteDeviceCommandResponse, error)
// Gets a structure managed by the enterprise.
GetStructure(context.Context, *GetStructureRequest) (*Structure, error)
// Lists structures managed by the enterprise.
ListStructures(context.Context, *ListStructuresRequest) (*ListStructuresResponse, error)
// Gets a room managed by the enterprise.
GetRoom(context.Context, *GetRoomRequest) (*Room, error)
// Lists rooms managed by the enterprise.
ListRooms(context.Context, *ListRoomsRequest) (*ListRoomsResponse, error)
}
Structure resource represents an instance of enterprise managed home or hotel room.
type Structure struct {
// Output only. The resource name of the structure. For example:
// "enterprises/XYZ/structures/ABC".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Structure traits.
Traits *structpb.Struct `protobuf:"bytes,2,opt,name=traits,proto3" json:"traits,omitempty"`
// contains filtered or unexported fields
}
func (*Structure) Descriptor() ([]byte, []int)
Deprecated: Use Structure.ProtoReflect.Descriptor instead.
func (x *Structure) GetName() string
func (x *Structure) GetTraits() *structpb.Struct
func (*Structure) ProtoMessage()
func (x *Structure) ProtoReflect() protoreflect.Message
func (x *Structure) Reset()
func (x *Structure) String() string
UnimplementedSmartDeviceManagementServiceServer can be embedded to have forward compatible implementations.
type UnimplementedSmartDeviceManagementServiceServer struct {
}
func (*UnimplementedSmartDeviceManagementServiceServer) ExecuteDeviceCommand(context.Context, *ExecuteDeviceCommandRequest) (*ExecuteDeviceCommandResponse, error)
func (*UnimplementedSmartDeviceManagementServiceServer) GetDevice(context.Context, *GetDeviceRequest) (*Device, error)
func (*UnimplementedSmartDeviceManagementServiceServer) GetRoom(context.Context, *GetRoomRequest) (*Room, error)
func (*UnimplementedSmartDeviceManagementServiceServer) GetStructure(context.Context, *GetStructureRequest) (*Structure, error)
func (*UnimplementedSmartDeviceManagementServiceServer) ListDevices(context.Context, *ListDevicesRequest) (*ListDevicesResponse, error)
func (*UnimplementedSmartDeviceManagementServiceServer) ListRooms(context.Context, *ListRoomsRequest) (*ListRoomsResponse, error)
func (*UnimplementedSmartDeviceManagementServiceServer) ListStructures(context.Context, *ListStructuresRequest) (*ListStructuresResponse, error)