Documentation

Google_Service_CloudFilestore_Resource_ProjectsLocationsInstances extends Google_Service_Resource
in package

The "instances" collection of methods.

Typical usage is: $fileService = new Google_Service_CloudFilestore(...); $instances = $fileService->instances;

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_CloudFilestore_Operation
Creates an instance. (instances.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudFilestore_Operation
Deletes an instance. (instances.delete)
get()  : Google_Service_CloudFilestore_Instance
Gets the details of a specific instance. (instances.get)
listProjectsLocationsInstances()  : Google_Service_CloudFilestore_ListInstancesResponse
Lists all instances in a project for either a specified location or for all locations. (instances.listProjectsLocationsInstances)
patch()  : Google_Service_CloudFilestore_Operation
Updates the settings of a specific instance. (instances.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 an instance. (instances.create)

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

Required. The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example us-west1-b.

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

Optional parameters.

Tags
opt_param

string instanceId Required. The name of the instance to create. The name must be unique for the specified project and location.

Return values
Google_Service_CloudFilestore_Operation —

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

listProjectsLocationsInstances()

Lists all instances in a project for either a specified location or for all locations. (instances.listProjectsLocationsInstances)

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

Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example us-west1-b. To retrieve instance information for all locations, use "-" for the {location} value.

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

Optional parameters.

Tags
opt_param

string orderBy Sort results. Supported values are "name", "name desc" or "" (unsorted).

opt_param

string pageToken The next_page_token value to use if there are additional results to retrieve for this list request.

opt_param

int pageSize The maximum number of items to return.

opt_param

string filter List filter.

Return values
Google_Service_CloudFilestore_ListInstancesResponse —

patch()

Updates the settings of a specific instance. (instances.patch)

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

Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

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

Optional parameters.

Tags
opt_param

string updateMask Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels"

Return values
Google_Service_CloudFilestore_Operation —

convertToArrayAndStripNulls()

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

Search results