1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudFilestore
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsInstances

ProjectsLocationsInstances

class ProjectsLocationsInstances extends Resource (View source)

The "instances" collection of methods.

Typical usage is:

 $fileService = new Google\Service\CloudFilestore(...);
 $instances = $fileService->projects_locations_instances;

Methods

Operation
create(string $parent, Instance $postBody, array $optParams = [])

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).

Operation
delete(string $name, array $optParams = [])

Deletes an instance. (instances.delete)

Instance
get(string $name, array $optParams = [])

Gets the details of a specific instance. (instances.get)

ListInstancesResponse
listProjectsLocationsInstances(string $parent, array $optParams = [])

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

Operation
patch(string $name, Instance $postBody, array $optParams = [])

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

Operation
promoteReplica(string $name, PromoteReplicaRequest $postBody, array $optParams = [])

Promote an standby instance (replica). (instances.promoteReplica)

Operation
restore(string $name, RestoreInstanceRequest $postBody, array $optParams = [])

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).

Operation
revert(string $name, RevertInstanceRequest $postBody, array $optParams = [])

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

Details

at line 54
Operation create(string $parent, Instance $postBody, array $optParams = [])

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).

(instances.create)

Parameters

string $parent

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 73
Operation delete(string $name, array $optParams = [])

Deletes an instance. (instances.delete)

Parameters

string $name

Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 88
Instance get(string $name, array $optParams = [])

Gets the details of a specific instance. (instances.get)

Parameters

string $name

Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.
array $optParams

Optional parameters.

Return Value

Instance

Exceptions

Exception

at line 114
ListInstancesResponse listProjectsLocationsInstances(string $parent, array $optParams = [])

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

Parameters

string $parent

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 Google Cloud zones, for example us-west1-b. To retrieve instance information for all locations, use "-" for the {location} value.
array $optParams

Optional parameters.

Return Value

ListInstancesResponse

Exceptions

Exception

at line 134
Operation patch(string $name, Instance $postBody, array $optParams = [])

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

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 151
Operation promoteReplica(string $name, PromoteReplicaRequest $postBody, array $optParams = [])

Promote an standby instance (replica). (instances.promoteReplica)

Parameters

string $name

Required. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
PromoteReplicaRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 171
Operation restore(string $name, RestoreInstanceRequest $postBody, array $optParams = [])

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).

(instances.restore)

Parameters

string $name

Required. The resource name of the instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}.
RestoreInstanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 189
Operation revert(string $name, RevertInstanceRequest $postBody, array $optParams = [])

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

(instances.revert)

Parameters

string $name

Required. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
RevertInstanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception