Documentation

Google_Service_Resourceviews_Resource_ZoneViews extends Google_Service_Resource
in package

The "zoneViews" collection of methods.

Typical usage is: $resourceviewsService = new Google_Service_Resourceviews(...); $zoneViews = $resourceviewsService->zoneViews;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
addResources()  : Google_Service_Resourceviews_Operation
Add resources to the view. (zoneViews.addResources)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Resourceviews_Operation
Delete a resource view. (zoneViews.delete)
get()  : Google_Service_Resourceviews_ResourceView
Get the information of a zonal resource view. (zoneViews.get)
getService()  : Google_Service_Resourceviews_ZoneViewsGetServiceResponse
Get the service information of a resource view or a resource.
insert()  : Google_Service_Resourceviews_Operation
Create a resource view. (zoneViews.insert)
listResources()  : Google_Service_Resourceviews_ZoneViewsListResourcesResponse
List the resources of the resource view. (zoneViews.listResources)
listZoneViews()  : Google_Service_Resourceviews_ZoneViewsList
List resource views. (zoneViews.listZoneViews)
removeResources()  : Google_Service_Resourceviews_Operation
Remove resources from the view. (zoneViews.removeResources)
setService()  : Google_Service_Resourceviews_Operation
Update the service information of a resource view or a resource.
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

addResources()

Add resources to the view. (zoneViews.addResources)

public addResources(string $project, string $zone, string $resourceView, Google_Service_Resourceviews_ZoneViewsAddResourcesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Resourceviews_Operation
Parameters
$project : string

The project name of the resource view.

$zone : string

The zone name of the resource view.

$resourceView : string

The name of the resource view.

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

Optional parameters.

Return values
Google_Service_Resourceviews_Operation

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

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

delete()

Delete a resource view. (zoneViews.delete)

public delete(string $project, string $zone, string $resourceView[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Resourceviews_Operation
Parameters
$project : string

The project name of the resource view.

$zone : string

The zone name of the resource view.

$resourceView : string

The name of the resource view.

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

Optional parameters.

Return values
Google_Service_Resourceviews_Operation

get()

Get the information of a zonal resource view. (zoneViews.get)

public get(string $project, string $zone, string $resourceView[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Resourceviews_ResourceView
Parameters
$project : string

The project name of the resource view.

$zone : string

The zone name of the resource view.

$resourceView : string

The name of the resource view.

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

Optional parameters.

Return values
Google_Service_Resourceviews_ResourceView

getService()

Get the service information of a resource view or a resource.

public getService(string $project, string $zone, string $resourceView[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Resourceviews_ZoneViewsGetServiceResponse

(zoneViews.getService)

Parameters
$project : string

The project name of the resource view.

$zone : string

The zone name of the resource view.

$resourceView : string

The name of the resource view.

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

Optional parameters.

Tags
opt_param

string resourceName The name of the resource if user wants to get the service information of the resource.

Return values
Google_Service_Resourceviews_ZoneViewsGetServiceResponse

insert()

Create a resource view. (zoneViews.insert)

public insert(string $project, string $zone, Google_Service_Resourceviews_ResourceView $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Resourceviews_Operation
Parameters
$project : string

The project name of the resource view.

$zone : string

The zone name of the resource view.

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

Optional parameters.

Return values
Google_Service_Resourceviews_Operation

listResources()

List the resources of the resource view. (zoneViews.listResources)

public listResources(string $project, string $zone, string $resourceView[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Resourceviews_ZoneViewsListResourcesResponse
Parameters
$project : string

The project name of the resource view.

$zone : string

The zone name of the resource view.

$resourceView : string

The name of the resource view.

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

Optional parameters.

Tags
opt_param

string format The requested format of the return value. It can be URL or URL_PORT. A JSON object will be included in the response based on the format. The default format is NONE, which results in no JSON in the response.

opt_param

string listState The state of the instance to list. By default, it lists all instances.

opt_param

int maxResults Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)

opt_param

string pageToken Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.

opt_param

string serviceName The service name to return in the response. It is optional and if it is not set, all the service end points will be returned.

Return values
Google_Service_Resourceviews_ZoneViewsListResourcesResponse

listZoneViews()

List resource views. (zoneViews.listZoneViews)

public listZoneViews(string $project, string $zone[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Resourceviews_ZoneViewsList
Parameters
$project : string

The project name of the resource view.

$zone : string

The zone name of the resource view.

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

Optional parameters.

Tags
opt_param

int maxResults Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)

opt_param

string pageToken Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.

Return values
Google_Service_Resourceviews_ZoneViewsList

removeResources()

Remove resources from the view. (zoneViews.removeResources)

public removeResources(string $project, string $zone, string $resourceView, Google_Service_Resourceviews_ZoneViewsRemoveResourcesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Resourceviews_Operation
Parameters
$project : string

The project name of the resource view.

$zone : string

The zone name of the resource view.

$resourceView : string

The name of the resource view.

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

Optional parameters.

Return values
Google_Service_Resourceviews_Operation

setService()

Update the service information of a resource view or a resource.

public setService(string $project, string $zone, string $resourceView, Google_Service_Resourceviews_ZoneViewsSetServiceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Resourceviews_Operation

(zoneViews.setService)

Parameters
$project : string

The project name of the resource view.

$zone : string

The zone name of the resource view.

$resourceView : string

The name of the resource view.

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

Optional parameters.

Return values
Google_Service_Resourceviews_Operation

convertToArrayAndStripNulls()

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

Search results