Smart Device Management API . enterprises . devices

close()

Close httplib2 connections.

executeCommand(name, body=None, x__xgafv=None)

Executes a command to device managed by the enterprise.

Args:
  name: string, The name of the device requested. For example: "enterprises/XYZ/devices/123" (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SmartDeviceManagementService.ExecuteDeviceCommand
  "command": "A String", # The command name to execute, represented by the fully qualified protobuf message name.
  "params": { # The command message to execute, represented as a Struct.
    "a_key": "", # Properties of the object.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SmartDeviceManagementService.ExecuteDeviceCommand
  "results": { # The results of executing the command.
    "a_key": "", # Properties of the object.
  },
}

get(name, x__xgafv=None)

Gets a device managed by the enterprise.

Args:
  name: string, The name of the device requested. For example: "enterprises/XYZ/devices/123" (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Device resource represents an instance of enterprise managed device in the property.
  "name": "A String", # Required. The resource name of the device. For example: "enterprises/XYZ/devices/123".
  "parentRelations": [ # Assignee details of the device.
    { # Represents device relationships, for instance, structure/room to which the device is assigned to.
      "displayName": "A String", # Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to.
      "parent": "A String", # 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"
    },
  ],
  "traits": { # Output only. Device traits.
    "a_key": "", # Properties of the object.
  },
  "type": "A String", # 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.
}

list(parent, filter=None, x__xgafv=None)

Lists devices managed by the enterprise.

Args:
  parent: string, The parent enterprise to list devices under. E.g. "enterprises/XYZ". (required)
  filter: string, Optional filter to list devices. Filters can be done on: Device custom name (substring match): 'customName=wing'
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SmartDeviceManagementService.ListDevices
  "devices": [ # The list of devices.
    { # Device resource represents an instance of enterprise managed device in the property.
      "name": "A String", # Required. The resource name of the device. For example: "enterprises/XYZ/devices/123".
      "parentRelations": [ # Assignee details of the device.
        { # Represents device relationships, for instance, structure/room to which the device is assigned to.
          "displayName": "A String", # Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to.
          "parent": "A String", # 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"
        },
      ],
      "traits": { # Output only. Device traits.
        "a_key": "", # Properties of the object.
      },
      "type": "A String", # 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.
    },
  ],
}