Documentation

Google_Service_Sasportal_Resource_CustomersNodes extends Google_Service_Resource
in package

The "nodes" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Sasportal_SasPortalNode
Creates a new node. (nodes.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Sasportal_SasPortalEmpty
Deletes a node. (nodes.delete)
get()  : Google_Service_Sasportal_SasPortalNode
Returns a requested node. (nodes.get)
listCustomersNodes()  : Google_Service_Sasportal_SasPortalListNodesResponse
Lists nodes. (nodes.listCustomersNodes)
move()  : Google_Service_Sasportal_SasPortalOperation
Moves a node under another node or customer. (nodes.move)
patch()  : Google_Service_Sasportal_SasPortalNode
Updates an existing node. (nodes.patch)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__construct()

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

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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

Creates a new node. (nodes.create)

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

Required. The parent resource name where the node is to be created.

$postBody : Google_Service_Sasportal_SasPortalNode
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Sasportal_SasPortalNode

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>
Tags
static
Return values
string

$requestUrl

listCustomersNodes()

Lists nodes. (nodes.listCustomersNodes)

public listCustomersNodes(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Sasportal_SasPortalListNodesResponse
Parameters
$parent : string

Required. The parent resource name, for example, "nodes/1".

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from.

opt_param

int pageSize The maximum number of nodes to return in the response.

Return values
Google_Service_Sasportal_SasPortalListNodesResponse

move()

Moves a node under another node or customer. (nodes.move)

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

Required. The name of the node to move.

$postBody : Google_Service_Sasportal_SasPortalMoveNodeRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Sasportal_SasPortalOperation

patch()

Updates an existing node. (nodes.patch)

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

Output only. Resource name.

$postBody : Google_Service_Sasportal_SasPortalNode
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Fields to be updated.

Return values
Google_Service_Sasportal_SasPortalNode

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results