Documentation

Google_Service_Sasportal_Resource_CustomersDevices extends Google_Service_Resource
in package

Application

The "devices" collection of methods.

Typical usage is: $sasportalService = new Google_Service_Sasportal(...); $devices = $sasportalService->devices;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
bulk() : Google_Service_Sasportal_SasPortalBulkCreateDeviceResponse: Creates a device under a node or customer. Returned devices are unordered.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Sasportal_SasPortalDevice: Creates a device under a node or customer. (devices.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
createSigned() : Google_Service_Sasportal_SasPortalDevice: Creates a signed device under a node or customer. (devices.createSigned)
delete() : Google_Service_Sasportal_SasPortalEmpty: Deletes a device. (devices.delete)
get() : Google_Service_Sasportal_SasPortalDevice: Gets details about a device. (devices.get)
listCustomersDevices() : Google_Service_Sasportal_SasPortalListDevicesResponse: Lists devices under a node or customer. (devices.listCustomersDevices)
move() : Google_Service_Sasportal_SasPortalOperation: Moves a device under another node or customer. (devices.move)
patch() : Google_Service_Sasportal_SasPortalDevice: Updates a device. (devices.patch)
signDevice() : Google_Service_Sasportal_SasPortalEmpty: Signs a device. (devices.signDevice)
updateSigned() : Google_Service_Sasportal_SasPortalDevice: Updates a signed device. (devices.updateSigned)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

bulk()

Creates a device under a node or customer. Returned devices are unordered.


    public
                bulk(string $parent, Google_Service_Sasportal_SasPortalBulkCreateDeviceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Sasportal_SasPortalBulkCreateDeviceResponse

(devices.bulk)

Parameters

$parent : string: Required. The name of the parent resource.
$postBody : Google_Service_Sasportal_SasPortalBulkCreateDeviceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Sasportal_SasPortalBulkCreateDeviceResponse —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a device under a node or customer. (devices.create)


    public
                create(string $parent, Google_Service_Sasportal_SasPortalDevice $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Sasportal_SasPortalDevice

Parameters

$parent : string: Required. The name of the parent resource.
$postBody : Google_Service_Sasportal_SasPortalDevice
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Sasportal_SasPortalDevice —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

createSigned()

Creates a signed device under a node or customer. (devices.createSigned)


    public
                createSigned(string $parent, Google_Service_Sasportal_SasPortalCreateSignedDeviceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Sasportal_SasPortalDevice

Parameters

$parent : string: Required. The name of the parent resource.
$postBody : Google_Service_Sasportal_SasPortalCreateSignedDeviceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Sasportal_SasPortalDevice —

delete()

Deletes a device. (devices.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Sasportal_SasPortalEmpty

Parameters

$name : string: Required. The name of the device.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Sasportal_SasPortalEmpty —

get()

Gets details about a device. (devices.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Sasportal_SasPortalDevice

Parameters

$name : string: Required. The name of the device.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Sasportal_SasPortalDevice —

listCustomersDevices()

Lists devices under a node or customer. (devices.listCustomersDevices)


    public
                listCustomersDevices(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Sasportal_SasPortalListDevicesResponse

Parameters

$parent : string: Required. The name of the parent resource.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Sasportal_SasPortalListDevicesResponse —

move()

Moves a device under another node or customer. (devices.move)


    public
                move(string $name, Google_Service_Sasportal_SasPortalMoveDeviceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Sasportal_SasPortalOperation

Parameters

$name : string: Required. The name of the device to move.
$postBody : Google_Service_Sasportal_SasPortalMoveDeviceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Sasportal_SasPortalOperation —

patch()

Updates a device. (devices.patch)


    public
                patch(string $name, Google_Service_Sasportal_SasPortalDevice $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Sasportal_SasPortalDevice

Parameters

$name : string: Output only. The resource path name.
$postBody : Google_Service_Sasportal_SasPortalDevice
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Sasportal_SasPortalDevice —

signDevice()

Signs a device. (devices.signDevice)


    public
                signDevice(string $name, Google_Service_Sasportal_SasPortalSignDeviceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Sasportal_SasPortalEmpty

Parameters

$name : string: Output only. The resource path name.
$postBody : Google_Service_Sasportal_SasPortalSignDeviceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Sasportal_SasPortalEmpty —

updateSigned()

Updates a signed device. (devices.updateSigned)


    public
                updateSigned(string $name, Google_Service_Sasportal_SasPortalUpdateSignedDeviceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Sasportal_SasPortalDevice

Parameters

$name : string: Required. The name of the device to update.
$postBody : Google_Service_Sasportal_SasPortalUpdateSignedDeviceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Sasportal_SasPortalDevice —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —