Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_google_home_enterprise_sdm_v1_device_proto protoreflect.FileDescriptor
View Source
var File_google_home_enterprise_sdm_v1_site_proto protoreflect.FileDescriptor
View Source
var File_google_home_enterprise_sdm_v1_smart_device_management_service_proto protoreflect.FileDescriptor

Functions

func RegisterSmartDeviceManagementServiceServer

func RegisterSmartDeviceManagementServiceServer(s *grpc.Server, srv SmartDeviceManagementServiceServer)

Types

type Device

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
}

Device resource represents an instance of enterprise managed device in the property.

func (*Device) Descriptor

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

Deprecated: Use Device.ProtoReflect.Descriptor instead.

func (*Device) GetName

func (x *Device) GetName() string

func (*Device) GetParentRelations

func (x *Device) GetParentRelations() []*ParentRelation

func (*Device) GetTraits

func (x *Device) GetTraits() *structpb.Struct

func (*Device) GetType

func (x *Device) GetType() string

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 ExecuteDeviceCommandRequest

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
}

Request message for SmartDeviceManagementService.ExecuteDeviceCommand

func (*ExecuteDeviceCommandRequest) Descriptor

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

Deprecated: Use ExecuteDeviceCommandRequest.ProtoReflect.Descriptor instead.

func (*ExecuteDeviceCommandRequest) GetCommand

func (x *ExecuteDeviceCommandRequest) GetCommand() string

func (*ExecuteDeviceCommandRequest) GetName

func (x *ExecuteDeviceCommandRequest) GetName() string

func (*ExecuteDeviceCommandRequest) GetParams

func (*ExecuteDeviceCommandRequest) ProtoMessage

func (*ExecuteDeviceCommandRequest) ProtoMessage()

func (*ExecuteDeviceCommandRequest) ProtoReflect

func (*ExecuteDeviceCommandRequest) Reset

func (x *ExecuteDeviceCommandRequest) Reset()

func (*ExecuteDeviceCommandRequest) String

func (x *ExecuteDeviceCommandRequest) String() string

type ExecuteDeviceCommandResponse

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
}

Response message for SmartDeviceManagementService.ExecuteDeviceCommand

func (*ExecuteDeviceCommandResponse) Descriptor

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

Deprecated: Use ExecuteDeviceCommandResponse.ProtoReflect.Descriptor instead.

func (*ExecuteDeviceCommandResponse) GetResults

func (x *ExecuteDeviceCommandResponse) GetResults() *structpb.Struct

func (*ExecuteDeviceCommandResponse) ProtoMessage

func (*ExecuteDeviceCommandResponse) ProtoMessage()

func (*ExecuteDeviceCommandResponse) ProtoReflect

func (*ExecuteDeviceCommandResponse) Reset

func (x *ExecuteDeviceCommandResponse) Reset()

func (*ExecuteDeviceCommandResponse) String

type GetDeviceRequest

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
}

Request message for SmartDeviceManagementService.GetDevice

func (*GetDeviceRequest) Descriptor

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

Deprecated: Use GetDeviceRequest.ProtoReflect.Descriptor instead.

func (*GetDeviceRequest) GetName

func (x *GetDeviceRequest) GetName() string

func (*GetDeviceRequest) ProtoMessage

func (*GetDeviceRequest) ProtoMessage()

func (*GetDeviceRequest) ProtoReflect

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

func (*GetDeviceRequest) Reset

func (x *GetDeviceRequest) Reset()

func (*GetDeviceRequest) String

func (x *GetDeviceRequest) String() string

type GetRoomRequest

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
}

Request message for SmartDeviceManagementService.GetRoom

func (*GetRoomRequest) Descriptor

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

Deprecated: Use GetRoomRequest.ProtoReflect.Descriptor instead.

func (*GetRoomRequest) GetName

func (x *GetRoomRequest) GetName() string

func (*GetRoomRequest) ProtoMessage

func (*GetRoomRequest) ProtoMessage()

func (*GetRoomRequest) ProtoReflect

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

func (*GetRoomRequest) Reset

func (x *GetRoomRequest) Reset()

func (*GetRoomRequest) String

func (x *GetRoomRequest) String() string

type GetStructureRequest

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
}

Request message for SmartDeviceManagementService.GetStructure

func (*GetStructureRequest) Descriptor

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

Deprecated: Use GetStructureRequest.ProtoReflect.Descriptor instead.

func (*GetStructureRequest) GetName

func (x *GetStructureRequest) GetName() string

func (*GetStructureRequest) ProtoMessage

func (*GetStructureRequest) ProtoMessage()

func (*GetStructureRequest) ProtoReflect

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

func (*GetStructureRequest) Reset

func (x *GetStructureRequest) Reset()

func (*GetStructureRequest) String

func (x *GetStructureRequest) String() string

type ListDevicesRequest

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 match the exact parent (could be a structure or a room):
	// 'parent=enterprises/XYZ/structures/jkl'
	// or filter by device custom name (substring match):
	// 'customName=wing'
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for SmartDeviceManagementService.ListDevices

func (*ListDevicesRequest) Descriptor

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

Deprecated: Use ListDevicesRequest.ProtoReflect.Descriptor instead.

func (*ListDevicesRequest) GetFilter

func (x *ListDevicesRequest) GetFilter() string

func (*ListDevicesRequest) GetPageSize

func (x *ListDevicesRequest) GetPageSize() int32

func (*ListDevicesRequest) GetPageToken

func (x *ListDevicesRequest) GetPageToken() string

func (*ListDevicesRequest) GetParent

func (x *ListDevicesRequest) GetParent() 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 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
}

Response message for SmartDeviceManagementService.ListDevices

func (*ListDevicesResponse) Descriptor

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) 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 ListRoomsRequest

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
}

Request message for SmartDeviceManagementService.ListRooms

func (*ListRoomsRequest) Descriptor

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

Deprecated: Use ListRoomsRequest.ProtoReflect.Descriptor instead.

func (*ListRoomsRequest) GetPageSize

func (x *ListRoomsRequest) GetPageSize() int32

func (*ListRoomsRequest) GetPageToken

func (x *ListRoomsRequest) GetPageToken() string

func (*ListRoomsRequest) GetParent

func (x *ListRoomsRequest) GetParent() string

func (*ListRoomsRequest) ProtoMessage

func (*ListRoomsRequest) ProtoMessage()

func (*ListRoomsRequest) ProtoReflect

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

func (*ListRoomsRequest) Reset

func (x *ListRoomsRequest) Reset()

func (*ListRoomsRequest) String

func (x *ListRoomsRequest) String() string

type ListRoomsResponse

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
}

Response message for SmartDeviceManagementService.ListRooms

func (*ListRoomsResponse) Descriptor

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

Deprecated: Use ListRoomsResponse.ProtoReflect.Descriptor instead.

func (*ListRoomsResponse) GetNextPageToken

func (x *ListRoomsResponse) GetNextPageToken() string

func (*ListRoomsResponse) GetRooms

func (x *ListRoomsResponse) GetRooms() []*Room

func (*ListRoomsResponse) ProtoMessage

func (*ListRoomsResponse) ProtoMessage()

func (*ListRoomsResponse) ProtoReflect

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

func (*ListRoomsResponse) Reset

func (x *ListRoomsResponse) Reset()

func (*ListRoomsResponse) String

func (x *ListRoomsResponse) String() string

type ListStructuresRequest

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
}

Request message for SmartDeviceManagementService.ListStructures

func (*ListStructuresRequest) Descriptor

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

Deprecated: Use ListStructuresRequest.ProtoReflect.Descriptor instead.

func (*ListStructuresRequest) GetFilter

func (x *ListStructuresRequest) GetFilter() string

func (*ListStructuresRequest) GetPageSize

func (x *ListStructuresRequest) GetPageSize() int32

func (*ListStructuresRequest) GetPageToken

func (x *ListStructuresRequest) GetPageToken() string

func (*ListStructuresRequest) GetParent

func (x *ListStructuresRequest) GetParent() string

func (*ListStructuresRequest) ProtoMessage

func (*ListStructuresRequest) ProtoMessage()

func (*ListStructuresRequest) ProtoReflect

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

func (*ListStructuresRequest) Reset

func (x *ListStructuresRequest) Reset()

func (*ListStructuresRequest) String

func (x *ListStructuresRequest) String() string

type ListStructuresResponse

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
}

Response message for SmartDeviceManagementService.ListStructures

func (*ListStructuresResponse) Descriptor

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

Deprecated: Use ListStructuresResponse.ProtoReflect.Descriptor instead.

func (*ListStructuresResponse) GetNextPageToken

func (x *ListStructuresResponse) GetNextPageToken() string

func (*ListStructuresResponse) GetStructures

func (x *ListStructuresResponse) GetStructures() []*Structure

func (*ListStructuresResponse) ProtoMessage

func (*ListStructuresResponse) ProtoMessage()

func (*ListStructuresResponse) ProtoReflect

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

func (*ListStructuresResponse) Reset

func (x *ListStructuresResponse) Reset()

func (*ListStructuresResponse) String

func (x *ListStructuresResponse) String() string

type ParentRelation

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
}

Represents device relationships, for instance, structure/room to which the device is assigned to. For now this is only filled in the enterprise flow.

func (*ParentRelation) Descriptor

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

Deprecated: Use ParentRelation.ProtoReflect.Descriptor instead.

func (*ParentRelation) GetDisplayName

func (x *ParentRelation) GetDisplayName() string

func (*ParentRelation) GetParent

func (x *ParentRelation) GetParent() string

func (*ParentRelation) ProtoMessage

func (*ParentRelation) ProtoMessage()

func (*ParentRelation) ProtoReflect

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

func (*ParentRelation) Reset

func (x *ParentRelation) Reset()

func (*ParentRelation) String

func (x *ParentRelation) String() string

type Room

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
}

Room resource represents an instance of sub-space within a structure such as rooms in a hotel suite or rental apartment.

func (*Room) Descriptor

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

Deprecated: Use Room.ProtoReflect.Descriptor instead.

func (*Room) GetName

func (x *Room) GetName() string

func (*Room) GetTraits

func (x *Room) GetTraits() *structpb.Struct

func (*Room) ProtoMessage

func (*Room) ProtoMessage()

func (*Room) ProtoReflect

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

func (*Room) Reset

func (x *Room) Reset()

func (*Room) String

func (x *Room) String() string

type SmartDeviceManagementServiceClient

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)
}

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 SmartDeviceManagementServiceServer

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)
}

SmartDeviceManagementServiceServer is the server API for SmartDeviceManagementService service.

type Structure

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
}

Structure resource represents an instance of enterprise managed home or hotel room.

func (*Structure) Descriptor

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

Deprecated: Use Structure.ProtoReflect.Descriptor instead.

func (*Structure) GetName

func (x *Structure) GetName() string

func (*Structure) GetTraits

func (x *Structure) GetTraits() *structpb.Struct

func (*Structure) ProtoMessage

func (*Structure) ProtoMessage()

func (*Structure) ProtoReflect

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

func (*Structure) Reset

func (x *Structure) Reset()

func (*Structure) String

func (x *Structure) String() string

type UnimplementedSmartDeviceManagementServiceServer

type UnimplementedSmartDeviceManagementServiceServer struct {
}

UnimplementedSmartDeviceManagementServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSmartDeviceManagementServiceServer) ExecuteDeviceCommand

func (*UnimplementedSmartDeviceManagementServiceServer) GetDevice

func (*UnimplementedSmartDeviceManagementServiceServer) GetRoom

func (*UnimplementedSmartDeviceManagementServiceServer) GetStructure

func (*UnimplementedSmartDeviceManagementServiceServer) ListDevices

func (*UnimplementedSmartDeviceManagementServiceServer) ListRooms

func (*UnimplementedSmartDeviceManagementServiceServer) ListStructures