genproto: google.golang.org/genproto/googleapis/home/graph/v1 Index | Files

package graph

import "google.golang.org/genproto/googleapis/home/graph/v1"

Index

Package Files

device.pb.go homegraph.pb.go

Variables

var File_google_home_graph_v1_device_proto protoreflect.FileDescriptor
var File_google_home_graph_v1_homegraph_proto protoreflect.FileDescriptor

func RegisterHomeGraphApiServiceServer Uses

func RegisterHomeGraphApiServiceServer(s *grpc.Server, srv HomeGraphApiServiceServer)

type AgentDeviceId Uses

type AgentDeviceId struct {

    // Third-party device ID.
    Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
    // contains filtered or unexported fields
}

Third-party device ID for one device.

func (*AgentDeviceId) Descriptor Uses

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

Deprecated: Use AgentDeviceId.ProtoReflect.Descriptor instead.

func (*AgentDeviceId) GetId Uses

func (x *AgentDeviceId) GetId() string

func (*AgentDeviceId) ProtoMessage Uses

func (*AgentDeviceId) ProtoMessage()

func (*AgentDeviceId) ProtoReflect Uses

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

func (*AgentDeviceId) Reset Uses

func (x *AgentDeviceId) Reset()

func (*AgentDeviceId) String Uses

func (x *AgentDeviceId) String() string

type AgentOtherDeviceId Uses

type AgentOtherDeviceId struct {

    // Project ID for your smart home Action.
    AgentId string `protobuf:"bytes,1,opt,name=agent_id,json=agentId,proto3" json:"agent_id,omitempty"`
    // Unique third-party device ID.
    DeviceId string `protobuf:"bytes,2,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
    // contains filtered or unexported fields
}

Alternate third-party device ID.

func (*AgentOtherDeviceId) Descriptor Uses

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

Deprecated: Use AgentOtherDeviceId.ProtoReflect.Descriptor instead.

func (*AgentOtherDeviceId) GetAgentId Uses

func (x *AgentOtherDeviceId) GetAgentId() string

func (*AgentOtherDeviceId) GetDeviceId Uses

func (x *AgentOtherDeviceId) GetDeviceId() string

func (*AgentOtherDeviceId) ProtoMessage Uses

func (*AgentOtherDeviceId) ProtoMessage()

func (*AgentOtherDeviceId) ProtoReflect Uses

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

func (*AgentOtherDeviceId) Reset Uses

func (x *AgentOtherDeviceId) Reset()

func (*AgentOtherDeviceId) String Uses

func (x *AgentOtherDeviceId) String() string

type DeleteAgentUserRequest Uses

type DeleteAgentUserRequest struct {

    // Request ID used for debugging.
    RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
    // Required. Third-party user ID.
    AgentUserId string `protobuf:"bytes,2,opt,name=agent_user_id,json=agentUserId,proto3" json:"agent_user_id,omitempty"`
    // contains filtered or unexported fields
}

Request type for the [`DeleteAgentUser`](#google.home.graph.v1.HomeGraphApiService.DeleteAgentUser) call.

func (*DeleteAgentUserRequest) Descriptor Uses

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

Deprecated: Use DeleteAgentUserRequest.ProtoReflect.Descriptor instead.

func (*DeleteAgentUserRequest) GetAgentUserId Uses

func (x *DeleteAgentUserRequest) GetAgentUserId() string

func (*DeleteAgentUserRequest) GetRequestId Uses

func (x *DeleteAgentUserRequest) GetRequestId() string

func (*DeleteAgentUserRequest) ProtoMessage Uses

func (*DeleteAgentUserRequest) ProtoMessage()

func (*DeleteAgentUserRequest) ProtoReflect Uses

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

func (*DeleteAgentUserRequest) Reset Uses

func (x *DeleteAgentUserRequest) Reset()

func (*DeleteAgentUserRequest) String Uses

func (x *DeleteAgentUserRequest) String() string

type Device Uses

type Device struct {

    // Third-party device ID.
    Id  string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
    // Hardware type of the device.
    // See [device
    // types](https://developers.google.com/assistant/smarthome/guides).
    Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
    // Traits supported by the device.
    // See [device
    // traits](https://developers.google.com/assistant/smarthome/traits).
    Traits []string `protobuf:"bytes,3,rep,name=traits,proto3" json:"traits,omitempty"`
    // Names given to this device by your smart home Action.
    Name *DeviceNames `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
    // Indicates whether your smart home Action will report state of this device
    // to Google via
    // [ReportStateAndNotification][google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification].
    WillReportState bool `protobuf:"varint,5,opt,name=will_report_state,json=willReportState,proto3" json:"will_report_state,omitempty"`
    // Suggested name for the room where this device is installed.
    // Google attempts to use this value during user setup.
    RoomHint string `protobuf:"bytes,6,opt,name=room_hint,json=roomHint,proto3" json:"room_hint,omitempty"`
    // Suggested name for the structure where this device is installed.
    // Google attempts to use this value during user setup.
    StructureHint string `protobuf:"bytes,7,opt,name=structure_hint,json=structureHint,proto3" json:"structure_hint,omitempty"`
    // Device manufacturer, model, hardware version, and software version.
    DeviceInfo *DeviceInfo `protobuf:"bytes,8,opt,name=device_info,json=deviceInfo,proto3" json:"device_info,omitempty"`
    // Attributes for the traits supported by the device.
    Attributes *_struct.Struct `protobuf:"bytes,9,opt,name=attributes,proto3" json:"attributes,omitempty"`
    // Custom device attributes stored in Home Graph and provided to your
    // smart home Action in each
    // [QUERY](https://developers.google.com/assistant/smarthome/reference/intent/query)
    // and
    // [EXECUTE](https://developers.google.com/assistant/smarthome/reference/intent/execute)
    // intent.
    CustomData *_struct.Struct `protobuf:"bytes,10,opt,name=custom_data,json=customData,proto3" json:"custom_data,omitempty"`
    // Alternate IDs associated with this device.
    // This is used to identify cloud synced devices enabled for [local
    // fulfillment](https://developers.google.com/assistant/smarthome/concepts/local).
    OtherDeviceIds []*AgentOtherDeviceId `protobuf:"bytes,11,rep,name=other_device_ids,json=otherDeviceIds,proto3" json:"other_device_ids,omitempty"`
    // Indicates whether your smart home Action will report notifications
    // to Google for this device via
    // [ReportStateAndNotification][google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification].
    //
    // If your smart home Action enables users to control device notifications,
    // you should update this field and call
    // [RequestSyncDevices][google.home.graph.v1.HomeGraphApiService.RequestSyncDevices].
    NotificationSupportedByAgent bool `protobuf:"varint,12,opt,name=notification_supported_by_agent,json=notificationSupportedByAgent,proto3" json:"notification_supported_by_agent,omitempty"`
    // contains filtered or unexported fields
}

Third-party device definition.

func (*Device) Descriptor Uses

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

Deprecated: Use Device.ProtoReflect.Descriptor instead.

func (*Device) GetAttributes Uses

func (x *Device) GetAttributes() *_struct.Struct

func (*Device) GetCustomData Uses

func (x *Device) GetCustomData() *_struct.Struct

func (*Device) GetDeviceInfo Uses

func (x *Device) GetDeviceInfo() *DeviceInfo

func (*Device) GetId Uses

func (x *Device) GetId() string

func (*Device) GetName Uses

func (x *Device) GetName() *DeviceNames

func (*Device) GetNotificationSupportedByAgent Uses

func (x *Device) GetNotificationSupportedByAgent() bool

func (*Device) GetOtherDeviceIds Uses

func (x *Device) GetOtherDeviceIds() []*AgentOtherDeviceId

func (*Device) GetRoomHint Uses

func (x *Device) GetRoomHint() string

func (*Device) GetStructureHint Uses

func (x *Device) GetStructureHint() string

func (*Device) GetTraits Uses

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

func (*Device) GetType Uses

func (x *Device) GetType() string

func (*Device) GetWillReportState Uses

func (x *Device) GetWillReportState() bool

func (*Device) ProtoMessage Uses

func (*Device) ProtoMessage()

func (*Device) ProtoReflect Uses

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

func (*Device) Reset Uses

func (x *Device) Reset()

func (*Device) String Uses

func (x *Device) String() string

type DeviceInfo Uses

type DeviceInfo struct {

    // Device manufacturer.
    Manufacturer string `protobuf:"bytes,1,opt,name=manufacturer,proto3" json:"manufacturer,omitempty"`
    // Device model.
    Model string `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
    // Device hardware version.
    HwVersion string `protobuf:"bytes,3,opt,name=hw_version,json=hwVersion,proto3" json:"hw_version,omitempty"`
    // Device software version.
    SwVersion string `protobuf:"bytes,4,opt,name=sw_version,json=swVersion,proto3" json:"sw_version,omitempty"`
    // contains filtered or unexported fields
}

Device information.

func (*DeviceInfo) Descriptor Uses

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

Deprecated: Use DeviceInfo.ProtoReflect.Descriptor instead.

func (*DeviceInfo) GetHwVersion Uses

func (x *DeviceInfo) GetHwVersion() string

func (*DeviceInfo) GetManufacturer Uses

func (x *DeviceInfo) GetManufacturer() string

func (*DeviceInfo) GetModel Uses

func (x *DeviceInfo) GetModel() string

func (*DeviceInfo) GetSwVersion Uses

func (x *DeviceInfo) GetSwVersion() string

func (*DeviceInfo) ProtoMessage Uses

func (*DeviceInfo) ProtoMessage()

func (*DeviceInfo) ProtoReflect Uses

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

func (*DeviceInfo) Reset Uses

func (x *DeviceInfo) Reset()

func (*DeviceInfo) String Uses

func (x *DeviceInfo) String() string

type DeviceNames Uses

type DeviceNames struct {

    // Primary name of the device, generally provided by the user.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // Additional names provided by the user for the device.
    Nicknames []string `protobuf:"bytes,2,rep,name=nicknames,proto3" json:"nicknames,omitempty"`
    // List of names provided by the manufacturer rather than the user, such as
    // serial numbers, SKUs, etc.
    DefaultNames []string `protobuf:"bytes,3,rep,name=default_names,json=defaultNames,proto3" json:"default_names,omitempty"`
    // contains filtered or unexported fields
}

Identifiers used to describe the device.

func (*DeviceNames) Descriptor Uses

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

Deprecated: Use DeviceNames.ProtoReflect.Descriptor instead.

func (*DeviceNames) GetDefaultNames Uses

func (x *DeviceNames) GetDefaultNames() []string

func (*DeviceNames) GetName Uses

func (x *DeviceNames) GetName() string

func (*DeviceNames) GetNicknames Uses

func (x *DeviceNames) GetNicknames() []string

func (*DeviceNames) ProtoMessage Uses

func (*DeviceNames) ProtoMessage()

func (*DeviceNames) ProtoReflect Uses

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

func (*DeviceNames) Reset Uses

func (x *DeviceNames) Reset()

func (*DeviceNames) String Uses

func (x *DeviceNames) String() string

type HomeGraphApiServiceClient Uses

type HomeGraphApiServiceClient interface {
    // Requests Google to send an `action.devices.SYNC`
    // [intent](https://developers.google.com/assistant/smarthome/reference/intent/sync)
    // to your smart home Action to update device metadata for the given user.
    //
    //
    // The third-party user's identity is passed via the `agent_user_id`
    // (see
    // [RequestSyncDevicesRequest][google.home.graph.v1.RequestSyncDevicesRequest]).
    // This request must be authorized using service account credentials from your
    // Actions console project.
    RequestSyncDevices(ctx context.Context, in *RequestSyncDevicesRequest, opts ...grpc.CallOption) (*RequestSyncDevicesResponse, error)
    // Reports device state and optionally sends device notifications.
    // Called by your smart home Action when the state of a third-party device
    // changes or you need to send a notification about the device.
    // See [Implement Report
    // State](https://developers.google.com/assistant/smarthome/develop/report-state)
    // for more information.
    //
    // This method updates the device state according to its declared
    // [traits](https://developers.google.com/assistant/smarthome/concepts/devices-traits).
    // Publishing a new state value outside of these traits will result in an
    // `INVALID_ARGUMENT` error response.
    //
    // The third-party user's identity is passed in via the `agent_user_id`
    // (see
    // [ReportStateAndNotificationRequest][google.home.graph.v1.ReportStateAndNotificationRequest]).
    // This request must be authorized using service account credentials from your
    // Actions console project.
    ReportStateAndNotification(ctx context.Context, in *ReportStateAndNotificationRequest, opts ...grpc.CallOption) (*ReportStateAndNotificationResponse, error)
    // Unlinks the given third-party user from your smart home Action.
    // All data related to this user will be deleted.
    //
    // For more details on how users link their accounts, see
    // [fulfillment and
    // authentication](https://developers.google.com/assistant/smarthome/concepts/fulfillment-authentication).
    //
    // The third-party user's identity is passed in via the `agent_user_id`
    // (see
    // [DeleteAgentUserRequest][google.home.graph.v1.DeleteAgentUserRequest]).
    // This request must be authorized using service account credentials from your
    // Actions console project.
    DeleteAgentUser(ctx context.Context, in *DeleteAgentUserRequest, opts ...grpc.CallOption) (*empty.Empty, error)
    // Gets the current states in Home Graph for the given set of the third-party
    // user's devices.
    //
    // The third-party user's identity is passed in via the `agent_user_id`
    // (see [QueryRequest][google.home.graph.v1.QueryRequest]).
    // This request must be authorized using service account credentials from your
    // Actions console project.
    Query(ctx context.Context, in *QueryRequest, opts ...grpc.CallOption) (*QueryResponse, error)
    // Gets all the devices associated with the given third-party user.
    //
    // The third-party user's identity is passed in via the `agent_user_id`
    // (see [SyncRequest][google.home.graph.v1.SyncRequest]).
    // This request must be authorized using service account credentials from your
    // Actions console project.
    Sync(ctx context.Context, in *SyncRequest, opts ...grpc.CallOption) (*SyncResponse, error)
}

HomeGraphApiServiceClient is the client API for HomeGraphApiService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewHomeGraphApiServiceClient Uses

func NewHomeGraphApiServiceClient(cc grpc.ClientConnInterface) HomeGraphApiServiceClient

type HomeGraphApiServiceServer Uses

type HomeGraphApiServiceServer interface {
    // Requests Google to send an `action.devices.SYNC`
    // [intent](https://developers.google.com/assistant/smarthome/reference/intent/sync)
    // to your smart home Action to update device metadata for the given user.
    //
    //
    // The third-party user's identity is passed via the `agent_user_id`
    // (see
    // [RequestSyncDevicesRequest][google.home.graph.v1.RequestSyncDevicesRequest]).
    // This request must be authorized using service account credentials from your
    // Actions console project.
    RequestSyncDevices(context.Context, *RequestSyncDevicesRequest) (*RequestSyncDevicesResponse, error)
    // Reports device state and optionally sends device notifications.
    // Called by your smart home Action when the state of a third-party device
    // changes or you need to send a notification about the device.
    // See [Implement Report
    // State](https://developers.google.com/assistant/smarthome/develop/report-state)
    // for more information.
    //
    // This method updates the device state according to its declared
    // [traits](https://developers.google.com/assistant/smarthome/concepts/devices-traits).
    // Publishing a new state value outside of these traits will result in an
    // `INVALID_ARGUMENT` error response.
    //
    // The third-party user's identity is passed in via the `agent_user_id`
    // (see
    // [ReportStateAndNotificationRequest][google.home.graph.v1.ReportStateAndNotificationRequest]).
    // This request must be authorized using service account credentials from your
    // Actions console project.
    ReportStateAndNotification(context.Context, *ReportStateAndNotificationRequest) (*ReportStateAndNotificationResponse, error)
    // Unlinks the given third-party user from your smart home Action.
    // All data related to this user will be deleted.
    //
    // For more details on how users link their accounts, see
    // [fulfillment and
    // authentication](https://developers.google.com/assistant/smarthome/concepts/fulfillment-authentication).
    //
    // The third-party user's identity is passed in via the `agent_user_id`
    // (see
    // [DeleteAgentUserRequest][google.home.graph.v1.DeleteAgentUserRequest]).
    // This request must be authorized using service account credentials from your
    // Actions console project.
    DeleteAgentUser(context.Context, *DeleteAgentUserRequest) (*empty.Empty, error)
    // Gets the current states in Home Graph for the given set of the third-party
    // user's devices.
    //
    // The third-party user's identity is passed in via the `agent_user_id`
    // (see [QueryRequest][google.home.graph.v1.QueryRequest]).
    // This request must be authorized using service account credentials from your
    // Actions console project.
    Query(context.Context, *QueryRequest) (*QueryResponse, error)
    // Gets all the devices associated with the given third-party user.
    //
    // The third-party user's identity is passed in via the `agent_user_id`
    // (see [SyncRequest][google.home.graph.v1.SyncRequest]).
    // This request must be authorized using service account credentials from your
    // Actions console project.
    Sync(context.Context, *SyncRequest) (*SyncResponse, error)
}

HomeGraphApiServiceServer is the server API for HomeGraphApiService service.

type QueryRequest Uses

type QueryRequest struct {

    // Request ID used for debugging.
    RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
    // Required. Third-party user ID.
    AgentUserId string `protobuf:"bytes,2,opt,name=agent_user_id,json=agentUserId,proto3" json:"agent_user_id,omitempty"`
    // Required. Inputs containing third-party device IDs for which to
    // get the device states.
    Inputs []*QueryRequestInput `protobuf:"bytes,3,rep,name=inputs,proto3" json:"inputs,omitempty"`
    // contains filtered or unexported fields
}

Request type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call.

func (*QueryRequest) Descriptor Uses

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

Deprecated: Use QueryRequest.ProtoReflect.Descriptor instead.

func (*QueryRequest) GetAgentUserId Uses

func (x *QueryRequest) GetAgentUserId() string

func (*QueryRequest) GetInputs Uses

func (x *QueryRequest) GetInputs() []*QueryRequestInput

func (*QueryRequest) GetRequestId Uses

func (x *QueryRequest) GetRequestId() string

func (*QueryRequest) ProtoMessage Uses

func (*QueryRequest) ProtoMessage()

func (*QueryRequest) ProtoReflect Uses

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

func (*QueryRequest) Reset Uses

func (x *QueryRequest) Reset()

func (*QueryRequest) String Uses

func (x *QueryRequest) String() string

type QueryRequestInput Uses

type QueryRequestInput struct {

    // Payload containing third-party device IDs.
    Payload *QueryRequestPayload `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
    // contains filtered or unexported fields
}

Device ID inputs to [QueryRequest][google.home.graph.v1.QueryRequest].

func (*QueryRequestInput) Descriptor Uses

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

Deprecated: Use QueryRequestInput.ProtoReflect.Descriptor instead.

func (*QueryRequestInput) GetPayload Uses

func (x *QueryRequestInput) GetPayload() *QueryRequestPayload

func (*QueryRequestInput) ProtoMessage Uses

func (*QueryRequestInput) ProtoMessage()

func (*QueryRequestInput) ProtoReflect Uses

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

func (*QueryRequestInput) Reset Uses

func (x *QueryRequestInput) Reset()

func (*QueryRequestInput) String Uses

func (x *QueryRequestInput) String() string

type QueryRequestPayload Uses

type QueryRequestPayload struct {

    // Third-party device IDs for which to get the device states.
    Devices []*AgentDeviceId `protobuf:"bytes,1,rep,name=devices,proto3" json:"devices,omitempty"`
    // contains filtered or unexported fields
}

Payload containing device IDs.

func (*QueryRequestPayload) Descriptor Uses

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

Deprecated: Use QueryRequestPayload.ProtoReflect.Descriptor instead.

func (*QueryRequestPayload) GetDevices Uses

func (x *QueryRequestPayload) GetDevices() []*AgentDeviceId

func (*QueryRequestPayload) ProtoMessage Uses

func (*QueryRequestPayload) ProtoMessage()

func (*QueryRequestPayload) ProtoReflect Uses

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

func (*QueryRequestPayload) Reset Uses

func (x *QueryRequestPayload) Reset()

func (*QueryRequestPayload) String Uses

func (x *QueryRequestPayload) String() string

type QueryResponse Uses

type QueryResponse struct {

    // Request ID used for debugging. Copied from the request.
    RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
    // Device states for the devices given in the request.
    Payload *QueryResponsePayload `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
    // contains filtered or unexported fields
}

Response type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. This should follow the same format as the Google smart home `action.devices.QUERY` [response](https://developers.google.com/assistant/smarthome/reference/intent/query). # Example

“`json {

"requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"payload": {
  "devices": {
    "123": {
      "on": true,
      "online": true
    },
    "456": {
      "on": true,
      "online": true,
      "brightness": 80,
      "color": {
        "name": "cerulean",
        "spectrumRGB": 31655
      }
    }
  }
}

} “`

func (*QueryResponse) Descriptor Uses

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

Deprecated: Use QueryResponse.ProtoReflect.Descriptor instead.

func (*QueryResponse) GetPayload Uses

func (x *QueryResponse) GetPayload() *QueryResponsePayload

func (*QueryResponse) GetRequestId Uses

func (x *QueryResponse) GetRequestId() string

func (*QueryResponse) ProtoMessage Uses

func (*QueryResponse) ProtoMessage()

func (*QueryResponse) ProtoReflect Uses

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

func (*QueryResponse) Reset Uses

func (x *QueryResponse) Reset()

func (*QueryResponse) String Uses

func (x *QueryResponse) String() string

type QueryResponsePayload Uses

type QueryResponsePayload struct {

    // States of the devices. Map of third-party device ID to struct of device
    // states.
    Devices map[string]*_struct.Struct `protobuf:"bytes,1,rep,name=devices,proto3" json:"devices,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // contains filtered or unexported fields
}

Payload containing device states information.

func (*QueryResponsePayload) Descriptor Uses

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

Deprecated: Use QueryResponsePayload.ProtoReflect.Descriptor instead.

func (*QueryResponsePayload) GetDevices Uses

func (x *QueryResponsePayload) GetDevices() map[string]*_struct.Struct

func (*QueryResponsePayload) ProtoMessage Uses

func (*QueryResponsePayload) ProtoMessage()

func (*QueryResponsePayload) ProtoReflect Uses

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

func (*QueryResponsePayload) Reset Uses

func (x *QueryResponsePayload) Reset()

func (*QueryResponsePayload) String Uses

func (x *QueryResponsePayload) String() string

type ReportStateAndNotificationDevice Uses

type ReportStateAndNotificationDevice struct {

    // States of devices to update. See the **Device STATES** section
    // of the individual trait [reference
    // guides](https://developers.google.com/assistant/smarthome/traits).
    States *_struct.Struct `protobuf:"bytes,1,opt,name=states,proto3" json:"states,omitempty"`
    // Notifications metadata for devices. See the **Device NOTIFICATIONS**
    // section of the individual trait [reference
    // guides](https://developers.google.com/assistant/smarthome/traits).
    Notifications *_struct.Struct `protobuf:"bytes,2,opt,name=notifications,proto3" json:"notifications,omitempty"`
    // contains filtered or unexported fields
}

The states and notifications specific to a device.

func (*ReportStateAndNotificationDevice) Descriptor Uses

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

Deprecated: Use ReportStateAndNotificationDevice.ProtoReflect.Descriptor instead.

func (*ReportStateAndNotificationDevice) GetNotifications Uses

func (x *ReportStateAndNotificationDevice) GetNotifications() *_struct.Struct

func (*ReportStateAndNotificationDevice) GetStates Uses

func (x *ReportStateAndNotificationDevice) GetStates() *_struct.Struct

func (*ReportStateAndNotificationDevice) ProtoMessage Uses

func (*ReportStateAndNotificationDevice) ProtoMessage()

func (*ReportStateAndNotificationDevice) ProtoReflect Uses

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

func (*ReportStateAndNotificationDevice) Reset Uses

func (x *ReportStateAndNotificationDevice) Reset()

func (*ReportStateAndNotificationDevice) String Uses

func (x *ReportStateAndNotificationDevice) String() string

type ReportStateAndNotificationRequest Uses

type ReportStateAndNotificationRequest struct {

    // Request ID used for debugging.
    RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
    // Unique identifier per event (for example, a doorbell press).
    EventId string `protobuf:"bytes,4,opt,name=event_id,json=eventId,proto3" json:"event_id,omitempty"`
    // Required. Third-party user ID.
    AgentUserId string `protobuf:"bytes,2,opt,name=agent_user_id,json=agentUserId,proto3" json:"agent_user_id,omitempty"`
    // Token to maintain state in the follow up notification response.
    // Deprecated. See the [notifications
    // guide](https://developers.google.com/assistant/smarthome/develop/notifications)
    // for details on implementing follow up notifications.
    //
    // Deprecated: Do not use.
    FollowUpToken string `protobuf:"bytes,5,opt,name=follow_up_token,json=followUpToken,proto3" json:"follow_up_token,omitempty"`
    // Required. State of devices to update and notification metadata for devices.
    Payload *StateAndNotificationPayload `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`
    // contains filtered or unexported fields
}

Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. It may include states, notifications, or both. States and notifications are defined per `device_id` (for example, "123" and "456" in the following example). # Example

“`json {

"requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"agentUserId": "1234",
"payload": {
  "devices": {
    "states": {
      "123": {
        "on": true
      },
      "456": {
        "on": true,
        "brightness": 10
      }
    },
  }
}

} “`

func (*ReportStateAndNotificationRequest) Descriptor Uses

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

Deprecated: Use ReportStateAndNotificationRequest.ProtoReflect.Descriptor instead.

func (*ReportStateAndNotificationRequest) GetAgentUserId Uses

func (x *ReportStateAndNotificationRequest) GetAgentUserId() string

func (*ReportStateAndNotificationRequest) GetEventId Uses

func (x *ReportStateAndNotificationRequest) GetEventId() string

func (*ReportStateAndNotificationRequest) GetFollowUpToken Uses

func (x *ReportStateAndNotificationRequest) GetFollowUpToken() string

Deprecated: Do not use.

func (*ReportStateAndNotificationRequest) GetPayload Uses

func (x *ReportStateAndNotificationRequest) GetPayload() *StateAndNotificationPayload

func (*ReportStateAndNotificationRequest) GetRequestId Uses

func (x *ReportStateAndNotificationRequest) GetRequestId() string

func (*ReportStateAndNotificationRequest) ProtoMessage Uses

func (*ReportStateAndNotificationRequest) ProtoMessage()

func (*ReportStateAndNotificationRequest) ProtoReflect Uses

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

func (*ReportStateAndNotificationRequest) Reset Uses

func (x *ReportStateAndNotificationRequest) Reset()

func (*ReportStateAndNotificationRequest) String Uses

func (x *ReportStateAndNotificationRequest) String() string

type ReportStateAndNotificationResponse Uses

type ReportStateAndNotificationResponse struct {

    // Request ID copied from
    // [ReportStateAndNotificationRequest][google.home.graph.v1.ReportStateAndNotificationRequest].
    RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
    // contains filtered or unexported fields
}

Response type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call.

func (*ReportStateAndNotificationResponse) Descriptor Uses

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

Deprecated: Use ReportStateAndNotificationResponse.ProtoReflect.Descriptor instead.

func (*ReportStateAndNotificationResponse) GetRequestId Uses

func (x *ReportStateAndNotificationResponse) GetRequestId() string

func (*ReportStateAndNotificationResponse) ProtoMessage Uses

func (*ReportStateAndNotificationResponse) ProtoMessage()

func (*ReportStateAndNotificationResponse) ProtoReflect Uses

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

func (*ReportStateAndNotificationResponse) Reset Uses

func (x *ReportStateAndNotificationResponse) Reset()

func (*ReportStateAndNotificationResponse) String Uses

func (x *ReportStateAndNotificationResponse) String() string

type RequestSyncDevicesRequest Uses

type RequestSyncDevicesRequest struct {

    // Required. Third-party user ID.
    AgentUserId string `protobuf:"bytes,1,opt,name=agent_user_id,json=agentUserId,proto3" json:"agent_user_id,omitempty"`
    // Optional. If set, the request will be added to a queue and a response will
    // be returned immediately. This enables concurrent requests for the given
    // `agent_user_id`, but the caller will not receive any error responses.
    Async bool `protobuf:"varint,2,opt,name=async,proto3" json:"async,omitempty"`
    // contains filtered or unexported fields
}

Request type for the [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) call.

func (*RequestSyncDevicesRequest) Descriptor Uses

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

Deprecated: Use RequestSyncDevicesRequest.ProtoReflect.Descriptor instead.

func (*RequestSyncDevicesRequest) GetAgentUserId Uses

func (x *RequestSyncDevicesRequest) GetAgentUserId() string

func (*RequestSyncDevicesRequest) GetAsync Uses

func (x *RequestSyncDevicesRequest) GetAsync() bool

func (*RequestSyncDevicesRequest) ProtoMessage Uses

func (*RequestSyncDevicesRequest) ProtoMessage()

func (*RequestSyncDevicesRequest) ProtoReflect Uses

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

func (*RequestSyncDevicesRequest) Reset Uses

func (x *RequestSyncDevicesRequest) Reset()

func (*RequestSyncDevicesRequest) String Uses

func (x *RequestSyncDevicesRequest) String() string

type RequestSyncDevicesResponse Uses

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

Response type for the [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService.RequestSyncDevices) call.

Intentionally empty upon success. An HTTP response code is returned with more details upon failure.

func (*RequestSyncDevicesResponse) Descriptor Uses

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

Deprecated: Use RequestSyncDevicesResponse.ProtoReflect.Descriptor instead.

func (*RequestSyncDevicesResponse) ProtoMessage Uses

func (*RequestSyncDevicesResponse) ProtoMessage()

func (*RequestSyncDevicesResponse) ProtoReflect Uses

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

func (*RequestSyncDevicesResponse) Reset Uses

func (x *RequestSyncDevicesResponse) Reset()

func (*RequestSyncDevicesResponse) String Uses

func (x *RequestSyncDevicesResponse) String() string

type StateAndNotificationPayload Uses

type StateAndNotificationPayload struct {

    // The devices for updating state and sending notifications.
    Devices *ReportStateAndNotificationDevice `protobuf:"bytes,1,opt,name=devices,proto3" json:"devices,omitempty"`
    // contains filtered or unexported fields
}

Payload containing the state and notification information for devices.

func (*StateAndNotificationPayload) Descriptor Uses

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

Deprecated: Use StateAndNotificationPayload.ProtoReflect.Descriptor instead.

func (*StateAndNotificationPayload) GetDevices Uses

func (x *StateAndNotificationPayload) GetDevices() *ReportStateAndNotificationDevice

func (*StateAndNotificationPayload) ProtoMessage Uses

func (*StateAndNotificationPayload) ProtoMessage()

func (*StateAndNotificationPayload) ProtoReflect Uses

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

func (*StateAndNotificationPayload) Reset Uses

func (x *StateAndNotificationPayload) Reset()

func (*StateAndNotificationPayload) String Uses

func (x *StateAndNotificationPayload) String() string

type SyncRequest Uses

type SyncRequest struct {

    // Request ID used for debugging.
    RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
    // Required. Third-party user ID.
    AgentUserId string `protobuf:"bytes,2,opt,name=agent_user_id,json=agentUserId,proto3" json:"agent_user_id,omitempty"`
    // contains filtered or unexported fields
}

Request type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call.

func (*SyncRequest) Descriptor Uses

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

Deprecated: Use SyncRequest.ProtoReflect.Descriptor instead.

func (*SyncRequest) GetAgentUserId Uses

func (x *SyncRequest) GetAgentUserId() string

func (*SyncRequest) GetRequestId Uses

func (x *SyncRequest) GetRequestId() string

func (*SyncRequest) ProtoMessage Uses

func (*SyncRequest) ProtoMessage()

func (*SyncRequest) ProtoReflect Uses

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

func (*SyncRequest) Reset Uses

func (x *SyncRequest) Reset()

func (*SyncRequest) String Uses

func (x *SyncRequest) String() string

type SyncResponse Uses

type SyncResponse struct {

    // Request ID used for debugging. Copied from the request.
    RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
    // Devices associated with the third-party user.
    Payload *SyncResponsePayload `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
    // contains filtered or unexported fields
}

Response type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call. This should follow the same format as the Google smart home `action.devices.SYNC` [response](https://developers.google.com/assistant/smarthome/reference/intent/sync). # Example

“`json {

"requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"payload": {
  "agentUserId": "1836.15267389",
  "devices": [{
    "id": "123",
    "type": "action.devices.types.OUTLET",
    "traits": [
      "action.devices.traits.OnOff"
    ],
    "name": {
      "defaultNames": ["My Outlet 1234"],
      "name": "Night light",
      "nicknames": ["wall plug"]
    },
    "willReportState": false,
    "deviceInfo": {
      "manufacturer": "lights-out-inc",
      "model": "hs1234",
      "hwVersion": "3.2",
      "swVersion": "11.4"
    },
    "customData": {
      "fooValue": 74,
      "barValue": true,
      "bazValue": "foo"
    }
  }]
}

} “`

func (*SyncResponse) Descriptor Uses

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

Deprecated: Use SyncResponse.ProtoReflect.Descriptor instead.

func (*SyncResponse) GetPayload Uses

func (x *SyncResponse) GetPayload() *SyncResponsePayload

func (*SyncResponse) GetRequestId Uses

func (x *SyncResponse) GetRequestId() string

func (*SyncResponse) ProtoMessage Uses

func (*SyncResponse) ProtoMessage()

func (*SyncResponse) ProtoReflect Uses

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

func (*SyncResponse) Reset Uses

func (x *SyncResponse) Reset()

func (*SyncResponse) String Uses

func (x *SyncResponse) String() string

type SyncResponsePayload Uses

type SyncResponsePayload struct {

    // Third-party user ID
    AgentUserId string `protobuf:"bytes,1,opt,name=agent_user_id,json=agentUserId,proto3" json:"agent_user_id,omitempty"`
    // Devices associated with the third-party user.
    Devices []*Device `protobuf:"bytes,2,rep,name=devices,proto3" json:"devices,omitempty"`
    // contains filtered or unexported fields
}

Payload containing device information.

func (*SyncResponsePayload) Descriptor Uses

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

Deprecated: Use SyncResponsePayload.ProtoReflect.Descriptor instead.

func (*SyncResponsePayload) GetAgentUserId Uses

func (x *SyncResponsePayload) GetAgentUserId() string

func (*SyncResponsePayload) GetDevices Uses

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

func (*SyncResponsePayload) ProtoMessage Uses

func (*SyncResponsePayload) ProtoMessage()

func (*SyncResponsePayload) ProtoReflect Uses

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

func (*SyncResponsePayload) Reset Uses

func (x *SyncResponsePayload) Reset()

func (*SyncResponsePayload) String Uses

func (x *SyncResponsePayload) String() string

type UnimplementedHomeGraphApiServiceServer Uses

type UnimplementedHomeGraphApiServiceServer struct {
}

UnimplementedHomeGraphApiServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedHomeGraphApiServiceServer) DeleteAgentUser Uses

func (*UnimplementedHomeGraphApiServiceServer) DeleteAgentUser(context.Context, *DeleteAgentUserRequest) (*empty.Empty, error)

func (*UnimplementedHomeGraphApiServiceServer) Query Uses

func (*UnimplementedHomeGraphApiServiceServer) Query(context.Context, *QueryRequest) (*QueryResponse, error)

func (*UnimplementedHomeGraphApiServiceServer) ReportStateAndNotification Uses

func (*UnimplementedHomeGraphApiServiceServer) ReportStateAndNotification(context.Context, *ReportStateAndNotificationRequest) (*ReportStateAndNotificationResponse, error)

func (*UnimplementedHomeGraphApiServiceServer) RequestSyncDevices Uses

func (*UnimplementedHomeGraphApiServiceServer) RequestSyncDevices(context.Context, *RequestSyncDevicesRequest) (*RequestSyncDevicesResponse, error)

func (*UnimplementedHomeGraphApiServiceServer) Sync Uses

func (*UnimplementedHomeGraphApiServiceServer) Sync(context.Context, *SyncRequest) (*SyncResponse, error)

Package graph imports 12 packages (graph). Updated 2020-08-13. Refresh now. Tools for package owners.