Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.InstancesResource

The "instances" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.InstancesResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudFilestore.v1
Assembly: Google.Apis.CloudFilestore.v1.dll
Syntax
public class ProjectsResource.LocationsResource.InstancesResource

Constructors

InstancesResource(IClientService)

Constructs a new resource.

Declaration
public InstancesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Snapshots

Gets the Snapshots resource.

Declaration
public virtual ProjectsResource.LocationsResource.InstancesResource.SnapshotsResource Snapshots { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.InstancesResource.SnapshotsResource

Methods

Create(Instance, string)

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

Declaration
public virtual ProjectsResource.LocationsResource.InstancesResource.CreateRequest Create(Instance body, string parent)
Parameters
Type Name Description
Instance body

The body of the request.

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.

Returns
Type Description
ProjectsResource.LocationsResource.InstancesResource.CreateRequest

Delete(string)

Deletes an instance.

Declaration
public virtual ProjectsResource.LocationsResource.InstancesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.LocationsResource.InstancesResource.DeleteRequest

Get(string)

Gets the details of a specific instance.

Declaration
public virtual ProjectsResource.LocationsResource.InstancesResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.LocationsResource.InstancesResource.GetRequest

List(string)

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

Declaration
public virtual ProjectsResource.LocationsResource.InstancesResource.ListRequest List(string parent)
Parameters
Type Name Description
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.

Returns
Type Description
ProjectsResource.LocationsResource.InstancesResource.ListRequest

Patch(Instance, string)

Updates the settings of a specific instance.

Declaration
public virtual ProjectsResource.LocationsResource.InstancesResource.PatchRequest Patch(Instance body, string name)
Parameters
Type Name Description
Instance body

The body of the request.

string name

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

Returns
Type Description
ProjectsResource.LocationsResource.InstancesResource.PatchRequest

PromoteReplica(PromoteReplicaRequest, string)

Promote the standby instance (replica).

Declaration
public virtual ProjectsResource.LocationsResource.InstancesResource.PromoteReplicaRequest PromoteReplica(PromoteReplicaRequest body, string name)
Parameters
Type Name Description
PromoteReplicaRequest body

The body of the request.

string name

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

Returns
Type Description
ProjectsResource.LocationsResource.InstancesResource.PromoteReplicaRequest

Restore(RestoreInstanceRequest, string)

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

Declaration
public virtual ProjectsResource.LocationsResource.InstancesResource.RestoreRequest Restore(RestoreInstanceRequest body, string name)
Parameters
Type Name Description
RestoreInstanceRequest body

The body of the request.

string name

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

Returns
Type Description
ProjectsResource.LocationsResource.InstancesResource.RestoreRequest

Revert(RevertInstanceRequest, string)

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

Declaration
public virtual ProjectsResource.LocationsResource.InstancesResource.RevertRequest Revert(RevertInstanceRequest body, string name)
Parameters
Type Name Description
RevertInstanceRequest body

The body of the request.

string name

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

Returns
Type Description
ProjectsResource.LocationsResource.InstancesResource.RevertRequest
In this article
Back to top Generated by DocFX