REST Resource: projects.locations.instances.shares

Resource: Share

A Filestore share.

JSON representation
{
  "name": string,
  "mountName": string,
  "description": string,
  "capacityGb": string,
  "nfsExportOptions": [
    {
      object (NfsExportOptions)
    }
  ],
  "state": enum (State),
  "createTime": string,
  "labels": {
    string: string,
    ...
  },

  // Union field source can be only one of the following:
  "backup": string
  // End of list of possible types for union field source.
}
Fields
name

string

Output only. The resource name of the share, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}/shares/{shareId}.

mountName

string

The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.

description

string

A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.

capacityGb

string (int64 format)

File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.

nfsExportOptions[]

object (NfsExportOptions)

Nfs Export Options. There is a limit of 10 export options per file share.

state

enum (State)

Output only. The share state.

createTime

string (Timestamp format)

Output only. The time when the share was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Resource labels to represent user provided metadata.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Union field source. The source that this Share has been restored from. Empty if the Share is created from scratch. source can be only one of the following:
backup

string

Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{projectId}/locations/{locationId}/backups/{backupId}. Empty, if the Share is created from scratch and not restored from a backup.

State

The share state.

Enums
STATE_UNSPECIFIED State not set.
CREATING Share is being created.
READY Share is ready for use.
DELETING Share is being deleted.

Methods

create

Creates a share.

delete

Deletes a share.

get

Gets the details of a specific share.

list

Lists all shares for a specified instance.

patch

Updates the settings of a specific share.