Google Cloud Ftp V1 Client - Class StorageDirectoryMapping (0.1.1)

Reference documentation and code samples for the Google Cloud Ftp V1 Client class StorageDirectoryMapping.

Mapping of backing Cloud Storage path to the directory where the user lands in the SFTP server. If directory is not specified, it'll default to '/'.

Eg 1 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: /abc/def/username) The user will land at /abcd/def/username, and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1' and there will be no such directory in the view. Eg 2 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: '') The user will land at '/', and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1/path2' and there will be no such directory in the view.

Generated from protobuf message google.cloud.ftp.v1.StorageDirectoryMapping

Namespace

Google \ Cloud \ Ftp \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ bucket`	`string` Required. Name of the bucket.
`↳ bucket_prefix`	`string` Optional. Prefix inside the bucket.
`↳ directory`	`string` Required. Directory where the user lands in the SFTP server.
`↳ permission`	`int` Required. Permission to the bucket.

getBucket

Required. Name of the bucket.

Returns
Type	Description
`string`

setBucket

Required. Name of the bucket.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBucketPrefix

Optional. Prefix inside the bucket.

Returns
Type	Description
`string`

setBucketPrefix

Optional. Prefix inside the bucket.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDirectory

Required. Directory where the user lands in the SFTP server.

Returns
Type	Description
`string`

setDirectory