Google Cloud Ftp V1 Client - Class User (0.1.1)

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

Message describing User object

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

Namespace

Google \ Cloud \ Ftp \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. [Output only] Create time stamp
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. [Output only] Update time stamp
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. Labels as key value pairs
`↳ username`	`string` Output only. [Output only] The username of the user.
`↳ customer_service_account`	`string` Required. Service account in customer project attached to this SFTP User.
`↳ state`	`int` Output only. Tracks user creation.
`↳ user_credentials`	`array<UserCredential>` Required. User credential for the user. The maximum number of user credentials is 10.
`↳ storage_directory_mappings`	`array<StorageDirectoryMapping>` Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.

getName

Identifier. User-friendly name via which User will be identified.

projects/{project}/locations/{location}/servers/{server}/users/{user}

Returns
Type	Description
`string`

setName

Identifier. User-friendly name via which User will be identified.

projects/{project}/locations/{location}/servers/{server}/users/{user}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. [Output only] Create time stamp

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. [Output only] Create time stamp

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. [Output only] Update time stamp

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. [Output only] Update time stamp

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLabels

Optional. Labels as key value pairs

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. Labels as key value pairs

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getUsername

Output only. [Output only] The username of the user.

Returns
Type	Description
`string`

setUsername

Output only. [Output only] The username of the user.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomerServiceAccount

Required. Service account in customer project attached to this SFTP User.

Returns
Type	Description
`string`

setCustomerServiceAccount