Google Cloud Filestore V1 Client - Class FileShareConfig (1.4.0)

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

File share configuration for the instance.

Generated from protobuf message google.cloud.filestore.v1.FileShareConfig

Namespace

Google \ Cloud \ Filestore \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the file share. Must use 1-16 characters for the basic service tier and 1-63 characters for all other service tiers. Must use lowercase letters, numbers, or underscores [a-z0-9_]. Must start with a letter. Immutable.

↳ capacity_gb int|string

File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes.

↳ source_backup string

The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

↳ nfs_export_options array<Google\Cloud\Filestore\V1\NfsExportOptions>

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

getName

Required. The name of the file share. Must use 1-16 characters for the basic service tier and 1-63 characters for all other service tiers.

Must use lowercase letters, numbers, or underscores [a-z0-9_]. Must start with a letter. Immutable.

Returns
TypeDescription
string

setName

Required. The name of the file share. Must use 1-16 characters for the basic service tier and 1-63 characters for all other service tiers.

Must use lowercase letters, numbers, or underscores [a-z0-9_]. Must start with a letter. Immutable.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCapacityGb

File share capacity in gigabytes (GB).

Filestore defines 1 GB as 1024^3 bytes.

Returns
TypeDescription
int|string

setCapacityGb

File share capacity in gigabytes (GB).

Filestore defines 1 GB as 1024^3 bytes.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getSourceBackup

The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

Returns
TypeDescription
string

hasSourceBackup

setSourceBackup

The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNfsExportOptions

Nfs Export Options.

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setNfsExportOptions

Nfs Export Options.

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

Parameter
NameDescription
var array<Google\Cloud\Filestore\V1\NfsExportOptions>
Returns
TypeDescription
$this

getSource

Returns
TypeDescription
string