Google Cloud Filestore V1 Client - Class CloudFilestoreManagerClient (1.4.0)

Version 1.4.0

• 1.5.7 (latest)
• 1.5.6
• 1.4.0
• 1.3.2
• 1.2.1
• 1.1.2
• 1.0.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Filestore V1 Client class CloudFilestoreManagerClient.

Service Description: Configures and manages Filestore resources.

Filestore Manager v1.

The file.googleapis.com service implements the Filestore API and defines the following resource model for managing instances:

• The service works with a collection of cloud projects, named: /projects/*
• Each project has a collection of available locations, named: /locations/*
• Each location has a collection of instances and backups, named: /instances/* and /backups/* respectively.
• As such, Filestore instances are resources of the form: /projects/{project_number}/locations/{location_id}/instances/{instance_id} and backups are resources of the form: /projects/{project_number}/locations/{location_id}/backup/{backup_id}

Note that location_id must be a Google Cloud zone for instances, but a Google Cloud region for backups; for example:

• projects/12345/locations/us-central1-c/instances/my-filestore
• projects/12345/locations/us-central1/backups/my-backup

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\Filestore\V1\CloudFilestoreManagerClient for the stable implementation

Namespace

Google \ Cloud \ Filestore \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createBackup

Creates a backup.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::createBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\CreateBackupRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createInstance

Creates an instance.

When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::createInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\CreateInstanceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createSnapshot

Creates a snapshot.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::createSnapshotAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\CreateSnapshotRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteBackup

Deletes a backup.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::deleteBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\DeleteBackupRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteInstance

Deletes an instance.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::deleteInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\DeleteInstanceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteSnapshot

Deletes a snapshot.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::deleteSnapshotAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\DeleteSnapshotRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

getBackup

Gets the details of a specific backup.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::getBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\GetBackupRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Filestore\V1\Backup

getInstance

Gets the details of a specific instance.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::getInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\GetInstanceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Filestore\V1\Instance

getSnapshot

Gets the details of a specific snapshot.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::getSnapshotAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\GetSnapshotRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Filestore\V1\Snapshot

listBackups

Lists all backups in a project for either a specified location or for all locations.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::listBackupsAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\ListBackupsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listInstances

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

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::listInstancesAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\ListInstancesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listSnapshots

Lists all snapshots in a project for either a specified location or for all locations.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::listSnapshotsAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\ListSnapshotsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

restoreInstance

Restores an existing instance's file share from a backup.

The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::restoreInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\RestoreInstanceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

revertInstance

Revert an existing instance's file system to a specified snapshot.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::revertInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\RevertInstanceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateBackup

Updates the settings of a specific backup.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::updateBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\UpdateBackupRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateInstance

Updates the settings of a specific instance.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::updateInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\UpdateInstanceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateSnapshot

Updates the settings of a specific snapshot.

The async variant is Google\Cloud\Filestore\V1\Client\CloudFilestoreManagerClient::updateSnapshotAsync() .

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\UpdateSnapshotRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createBackupAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\CreateBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createInstanceAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\CreateInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createSnapshotAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\CreateSnapshotRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteBackupAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\DeleteBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteInstanceAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\DeleteInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteSnapshotAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\DeleteSnapshotRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getBackupAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\GetBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getInstanceAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\GetInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getSnapshotAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\GetSnapshotRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listBackupsAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\ListBackupsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listInstancesAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\ListInstancesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listSnapshotsAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\ListSnapshotsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

restoreInstanceAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\RestoreInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

revertInstanceAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\RevertInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateBackupAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\UpdateBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateInstanceAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\UpdateInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateSnapshotAsync

Parameters
Name	Description
request	Google\Cloud\Filestore\V1\UpdateSnapshotRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
operationName	string The name of the long running operation
methodName	string The name of the method used to start the operation

Returns
Type	Description
Google\ApiCore\OperationResponse

static::backupName

Formats a string containing the fully-qualified path to represent a backup resource.

Parameters
Name	Description
project	string
location	string
backup	string

Returns
Type	Description
string	The formatted backup resource.

static::instanceName

Formats a string containing the fully-qualified path to represent a instance resource.

Parameters
Name	Description
project	string
location	string
instance	string

Returns
Type	Description
string	The formatted instance resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	The formatted location resource.

static::snapshotName

Formats a string containing the fully-qualified path to represent a snapshot resource.

Parameters
Name	Description
project	string
location	string
instance	string
snapshot	string

Returns
Type	Description
string	The formatted snapshot resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• backup: projects/{project}/locations/{location}/backups/{backup}
• instance: projects/{project}/locations/{location}/instances/{instance}
• location: projects/{project}/locations/{location}
• snapshot: projects/{project}/locations/{location}/instances/{instance}/snapshots/{snapshot}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.