smartdevicemanagement

package
v0.181.0 Latest Latest
Warning

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

 Go to latest Published: May 16, 2024 License: BSD-3-Clause Imports: 16 Imported by: 8

Documentation

Overview

Package smartdevicemanagement provides access to the Smart Device Management API.

For product documentation, see: https://developers.google.com/nest/device-access

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/smartdevicemanagement/v1"
...
ctx := context.Background()
smartdevicemanagementService, err := smartdevicemanagement.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

smartdevicemanagementService, err := smartdevicemanagement.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
smartdevicemanagementService, err := smartdevicemanagement.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
const (
	// See and/or control the devices that you selected
	SdmServiceScope = "https://www.googleapis.com/auth/sdm.service"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type EnterprisesDevicesExecuteCommandCall 

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

func (*EnterprisesDevicesExecuteCommandCall) Context 

func (c *EnterprisesDevicesExecuteCommandCall) Context(ctx context.Context) *EnterprisesDevicesExecuteCommandCall

Context sets the context to be used in this call's Do method.

func (*EnterprisesDevicesExecuteCommandCall) Do 

func (c *EnterprisesDevicesExecuteCommandCall) Do(opts ...googleapi.CallOption) (*GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse, error)

Do executes the "smartdevicemanagement.enterprises.devices.executeCommand" call. Any non-2xx status code is an error. Response headers are in either *GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*EnterprisesDevicesExecuteCommandCall) Fields 

func (c *EnterprisesDevicesExecuteCommandCall) Fields(s ...googleapi.Field) *EnterprisesDevicesExecuteCommandCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*EnterprisesDevicesExecuteCommandCall) Header 

func (c *EnterprisesDevicesExecuteCommandCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type EnterprisesDevicesGetCall 

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

func (*EnterprisesDevicesGetCall) Context 

func (c *EnterprisesDevicesGetCall) Context(ctx context.Context) *EnterprisesDevicesGetCall

Context sets the context to be used in this call's Do method.

func (*EnterprisesDevicesGetCall) Do 

func (c *EnterprisesDevicesGetCall) Do(opts ...googleapi.CallOption) (*GoogleHomeEnterpriseSdmV1Device, error)

Do executes the "smartdevicemanagement.enterprises.devices.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleHomeEnterpriseSdmV1Device.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*EnterprisesDevicesGetCall) Fields 

func (c *EnterprisesDevicesGetCall) Fields(s ...googleapi.Field) *EnterprisesDevicesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*EnterprisesDevicesGetCall) Header 

func (c *EnterprisesDevicesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*EnterprisesDevicesGetCall) IfNoneMatch 

func (c *EnterprisesDevicesGetCall) IfNoneMatch(entityTag string) *EnterprisesDevicesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type EnterprisesDevicesListCall 

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

func (*EnterprisesDevicesListCall) Context 

func (c *EnterprisesDevicesListCall) Context(ctx context.Context) *EnterprisesDevicesListCall

Context sets the context to be used in this call's Do method.

func (*EnterprisesDevicesListCall) Do 

func (c *EnterprisesDevicesListCall) Do(opts ...googleapi.CallOption) (*GoogleHomeEnterpriseSdmV1ListDevicesResponse, error)

Do executes the "smartdevicemanagement.enterprises.devices.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleHomeEnterpriseSdmV1ListDevicesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*EnterprisesDevicesListCall) Fields 

func (c *EnterprisesDevicesListCall) Fields(s ...googleapi.Field) *EnterprisesDevicesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*EnterprisesDevicesListCall) Filter 

func (c *EnterprisesDevicesListCall) Filter(filter string) *EnterprisesDevicesListCall

Filter sets the optional parameter "filter": Optional filter to list devices. Filters can be done on: Device custom name (substring match): 'customName=wing'

func (*EnterprisesDevicesListCall) Header 

func (c *EnterprisesDevicesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*EnterprisesDevicesListCall) IfNoneMatch 

func (c *EnterprisesDevicesListCall) IfNoneMatch(entityTag string) *EnterprisesDevicesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type EnterprisesDevicesService 

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

func NewEnterprisesDevicesService 

func NewEnterprisesDevicesService(s *Service) *EnterprisesDevicesService

func (*EnterprisesDevicesService) ExecuteCommand 

func (r *EnterprisesDevicesService) ExecuteCommand(name string, googlehomeenterprisesdmv1executedevicecommandrequest *GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest) *EnterprisesDevicesExecuteCommandCall

ExecuteCommand: Executes a command to device managed by the enterprise.

  • name: The name of the device requested. For example: "enterprises/XYZ/devices/123".

func (*EnterprisesDevicesService) Get 

func (r *EnterprisesDevicesService) Get(name string) *EnterprisesDevicesGetCall

Get: Gets a device managed by the enterprise.

  • name: The name of the device requested. For example: "enterprises/XYZ/devices/123".

func (*EnterprisesDevicesService) List 

func (r *EnterprisesDevicesService) List(parent string) *EnterprisesDevicesListCall

List: Lists devices managed by the enterprise.

  • parent: The parent enterprise to list devices under. E.g. "enterprises/XYZ".

type EnterprisesService 

type EnterprisesService struct {
	Devices *EnterprisesDevicesService

	Structures *EnterprisesStructuresService
	// contains filtered or unexported fields
}

func NewEnterprisesService 

func NewEnterprisesService(s *Service) *EnterprisesService

type EnterprisesStructuresGetCall 

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

func (*EnterprisesStructuresGetCall) Context 

func (c *EnterprisesStructuresGetCall) Context(ctx context.Context) *EnterprisesStructuresGetCall

Context sets the context to be used in this call's Do method.

func (*EnterprisesStructuresGetCall) Do 

func (c *EnterprisesStructuresGetCall) Do(opts ...googleapi.CallOption) (*GoogleHomeEnterpriseSdmV1Structure, error)

Do executes the "smartdevicemanagement.enterprises.structures.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleHomeEnterpriseSdmV1Structure.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*EnterprisesStructuresGetCall) Fields 

func (c *EnterprisesStructuresGetCall) Fields(s ...googleapi.Field) *EnterprisesStructuresGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*EnterprisesStructuresGetCall) Header 

func (c *EnterprisesStructuresGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*EnterprisesStructuresGetCall) IfNoneMatch 

func (c *EnterprisesStructuresGetCall) IfNoneMatch(entityTag string) *EnterprisesStructuresGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type EnterprisesStructuresListCall 

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

func (*EnterprisesStructuresListCall) Context 

func (c *EnterprisesStructuresListCall) Context(ctx context.Context) *EnterprisesStructuresListCall

Context sets the context to be used in this call's Do method.

func (*EnterprisesStructuresListCall) Do 

func (c *EnterprisesStructuresListCall) Do(opts ...googleapi.CallOption) (*GoogleHomeEnterpriseSdmV1ListStructuresResponse, error)

Do executes the "smartdevicemanagement.enterprises.structures.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleHomeEnterpriseSdmV1ListStructuresResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*EnterprisesStructuresListCall) Fields 

func (c *EnterprisesStructuresListCall) Fields(s ...googleapi.Field) *EnterprisesStructuresListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*EnterprisesStructuresListCall) Filter 

func (c *EnterprisesStructuresListCall) Filter(filter string) *EnterprisesStructuresListCall

Filter sets the optional parameter "filter": Optional filter to list structures.

func (*EnterprisesStructuresListCall) Header 

func (c *EnterprisesStructuresListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*EnterprisesStructuresListCall) IfNoneMatch 

func (c *EnterprisesStructuresListCall) IfNoneMatch(entityTag string) *EnterprisesStructuresListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type EnterprisesStructuresRoomsGetCall 

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

func (*EnterprisesStructuresRoomsGetCall) Context 

func (c *EnterprisesStructuresRoomsGetCall) Context(ctx context.Context) *EnterprisesStructuresRoomsGetCall

Context sets the context to be used in this call's Do method.

func (*EnterprisesStructuresRoomsGetCall) Do 

func (c *EnterprisesStructuresRoomsGetCall) Do(opts ...googleapi.CallOption) (*GoogleHomeEnterpriseSdmV1Room, error)

Do executes the "smartdevicemanagement.enterprises.structures.rooms.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleHomeEnterpriseSdmV1Room.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*EnterprisesStructuresRoomsGetCall) Fields 

func (c *EnterprisesStructuresRoomsGetCall) Fields(s ...googleapi.Field) *EnterprisesStructuresRoomsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*EnterprisesStructuresRoomsGetCall) Header 

func (c *EnterprisesStructuresRoomsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*EnterprisesStructuresRoomsGetCall) IfNoneMatch 

func (c *EnterprisesStructuresRoomsGetCall) IfNoneMatch(entityTag string) *EnterprisesStructuresRoomsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type EnterprisesStructuresRoomsListCall 

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

func (*EnterprisesStructuresRoomsListCall) Context 

func (c *EnterprisesStructuresRoomsListCall) Context(ctx context.Context) *EnterprisesStructuresRoomsListCall

Context sets the context to be used in this call's Do method.

func (*EnterprisesStructuresRoomsListCall) Do 

func (c *EnterprisesStructuresRoomsListCall) Do(opts ...googleapi.CallOption) (*GoogleHomeEnterpriseSdmV1ListRoomsResponse, error)

Do executes the "smartdevicemanagement.enterprises.structures.rooms.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleHomeEnterpriseSdmV1ListRoomsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*EnterprisesStructuresRoomsListCall) Fields 

func (c *EnterprisesStructuresRoomsListCall) Fields(s ...googleapi.Field) *EnterprisesStructuresRoomsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*EnterprisesStructuresRoomsListCall) Header 

func (c *EnterprisesStructuresRoomsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*EnterprisesStructuresRoomsListCall) IfNoneMatch 

func (c *EnterprisesStructuresRoomsListCall) IfNoneMatch(entityTag string) *EnterprisesStructuresRoomsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type EnterprisesStructuresRoomsService 

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

func NewEnterprisesStructuresRoomsService 

func NewEnterprisesStructuresRoomsService(s *Service) *EnterprisesStructuresRoomsService

func (*EnterprisesStructuresRoomsService) Get 

func (r *EnterprisesStructuresRoomsService) Get(name string) *EnterprisesStructuresRoomsGetCall

Get: Gets a room managed by the enterprise.

  • name: The name of the room requested. For example: "enterprises/XYZ/structures/ABC/rooms/123".

func (*EnterprisesStructuresRoomsService) List 

func (r *EnterprisesStructuresRoomsService) List(parent string) *EnterprisesStructuresRoomsListCall

List: Lists rooms managed by the enterprise.

  • parent: The parent resource name of the rooms requested. For example: "enterprises/XYZ/structures/ABC".

type EnterprisesStructuresService 

type EnterprisesStructuresService struct {
	Rooms *EnterprisesStructuresRoomsService
	// contains filtered or unexported fields
}

func NewEnterprisesStructuresService 

func NewEnterprisesStructuresService(s *Service) *EnterprisesStructuresService

func (*EnterprisesStructuresService) Get 

func (r *EnterprisesStructuresService) Get(name string) *EnterprisesStructuresGetCall

Get: Gets a structure managed by the enterprise.

  • name: The name of the structure requested. For example: "enterprises/XYZ/structures/ABC".

func (*EnterprisesStructuresService) List 

func (r *EnterprisesStructuresService) List(parent string) *EnterprisesStructuresListCall

List: Lists structures managed by the enterprise.

  • parent: The parent enterprise to list structures under. E.g. "enterprises/XYZ".

type GoogleHomeEnterpriseSdmV1Device 

type GoogleHomeEnterpriseSdmV1Device struct {
	// Name: Required. The resource name of the device. For example:
	// "enterprises/XYZ/devices/123".
	Name string `json:"name,omitempty"`
	// ParentRelations: Assignee details of the device.
	ParentRelations []*GoogleHomeEnterpriseSdmV1ParentRelation `json:"parentRelations,omitempty"`
	// Traits: Output only. Device traits.
	Traits googleapi.RawMessage `json:"traits,omitempty"`
	// Type: 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 `json:"type,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*GoogleHomeEnterpriseSdmV1Device) MarshalJSON 

func (s *GoogleHomeEnterpriseSdmV1Device) MarshalJSON() ([]byte, error)

type GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest 

type GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest struct {
	// Command: The command name to execute, represented by the fully qualified
	// protobuf message name.
	Command string `json:"command,omitempty"`
	// Params: The command message to execute, represented as a Struct.
	Params googleapi.RawMessage `json:"params,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Command") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Command") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest: Request message for SmartDeviceManagementService.ExecuteDeviceCommand

func (*GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest) MarshalJSON 

func (s *GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest) MarshalJSON() ([]byte, error)

type GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse 

type GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse struct {
	// Results: The results of executing the command.
	Results googleapi.RawMessage `json:"results,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Results") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Results") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse: Response message for SmartDeviceManagementService.ExecuteDeviceCommand

func (*GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse) MarshalJSON 

func (s *GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse) MarshalJSON() ([]byte, error)

type GoogleHomeEnterpriseSdmV1ListDevicesResponse 

type GoogleHomeEnterpriseSdmV1ListDevicesResponse struct {
	// Devices: The list of devices.
	Devices []*GoogleHomeEnterpriseSdmV1Device `json:"devices,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Devices") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Devices") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleHomeEnterpriseSdmV1ListDevicesResponse: Response message for SmartDeviceManagementService.ListDevices

func (*GoogleHomeEnterpriseSdmV1ListDevicesResponse) MarshalJSON 

func (s *GoogleHomeEnterpriseSdmV1ListDevicesResponse) MarshalJSON() ([]byte, error)

type GoogleHomeEnterpriseSdmV1ListRoomsResponse 

type GoogleHomeEnterpriseSdmV1ListRoomsResponse struct {
	// Rooms: The list of rooms.
	Rooms []*GoogleHomeEnterpriseSdmV1Room `json:"rooms,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Rooms") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Rooms") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleHomeEnterpriseSdmV1ListRoomsResponse: Response message for SmartDeviceManagementService.ListRooms

func (*GoogleHomeEnterpriseSdmV1ListRoomsResponse) MarshalJSON 

func (s *GoogleHomeEnterpriseSdmV1ListRoomsResponse) MarshalJSON() ([]byte, error)

type GoogleHomeEnterpriseSdmV1ListStructuresResponse 

type GoogleHomeEnterpriseSdmV1ListStructuresResponse struct {
	// Structures: The list of structures.
	Structures []*GoogleHomeEnterpriseSdmV1Structure `json:"structures,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Structures") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Structures") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleHomeEnterpriseSdmV1ListStructuresResponse: Response message for SmartDeviceManagementService.ListStructures

func (*GoogleHomeEnterpriseSdmV1ListStructuresResponse) MarshalJSON 

func (s *GoogleHomeEnterpriseSdmV1ListStructuresResponse) MarshalJSON() ([]byte, error)

type GoogleHomeEnterpriseSdmV1ParentRelation 

type GoogleHomeEnterpriseSdmV1ParentRelation struct {
	// DisplayName: Output only. The custom name of the relation -- e.g.,
	// structure/room where the device is assigned to.
	DisplayName string `json:"displayName,omitempty"`
	// Parent: 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 `json:"parent,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleHomeEnterpriseSdmV1ParentRelation: Represents device relationships, for instance, structure/room to which the device is assigned to.

func (*GoogleHomeEnterpriseSdmV1ParentRelation) MarshalJSON 

func (s *GoogleHomeEnterpriseSdmV1ParentRelation) MarshalJSON() ([]byte, error)

type GoogleHomeEnterpriseSdmV1Room 

type GoogleHomeEnterpriseSdmV1Room struct {
	// Name: Output only. The resource name of the room. For example:
	// "enterprises/XYZ/structures/ABC/rooms/123".
	Name string `json:"name,omitempty"`
	// Traits: Room traits.
	Traits googleapi.RawMessage `json:"traits,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*GoogleHomeEnterpriseSdmV1Room) MarshalJSON 

func (s *GoogleHomeEnterpriseSdmV1Room) MarshalJSON() ([]byte, error)

type GoogleHomeEnterpriseSdmV1Structure 

type GoogleHomeEnterpriseSdmV1Structure struct {
	// Name: Output only. The resource name of the structure. For example:
	// "enterprises/XYZ/structures/ABC".
	Name string `json:"name,omitempty"`
	// Traits: Structure traits.
	Traits googleapi.RawMessage `json:"traits,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*GoogleHomeEnterpriseSdmV1Structure) MarshalJSON 

func (s *GoogleHomeEnterpriseSdmV1Structure) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Enterprises *EnterprisesService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.