Google Cloud OsLogin Client - Class PosixAccount (1.8.0)

Reference documentation and code samples for the Google Cloud OsLogin Client class PosixAccount.

The POSIX account information associated with a Google account.

Generated from protobuf message google.cloud.oslogin.common.PosixAccount

Namespace

Google \ Cloud \ OsLogin \ Common

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ primary`	`bool` Only one POSIX account can be marked as primary.
`↳ username`	`string` The username of the POSIX account.
`↳ uid`	`int\|string` The user ID.
`↳ gid`	`int\|string` The default group ID.
`↳ home_directory`	`string` The path to the home directory for this account.
`↳ shell`	`string` The path to the logic shell for this account.
`↳ gecos`	`string` The GECOS (user information) entry for this account.
`↳ system_id`	`string` System identifier for which account the username or uid applies to. By default, the empty value is used.
`↳ account_id`	`string` Output only. A POSIX account identifier.
`↳ operating_system_type`	`int` The operating system type where this account applies.
`↳ name`	`string` Output only. The canonical resource name.

getPrimary

Only one POSIX account can be marked as primary.

Returns
Type	Description
`bool`

setPrimary

Only one POSIX account can be marked as primary.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getUsername

The username of the POSIX account.

Returns
Type	Description
`string`

setUsername

The username of the POSIX account.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

The user ID.

Returns
Type	Description
`int\|string`

setUid

The user ID.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getGid

The default group ID.

Returns
Type	Description
`int\|string`

setGid

The default group ID.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getHomeDirectory

The path to the home directory for this account.

Returns
Type	Description
`string`

setHomeDirectory

The path to the home directory for this account.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getShell

The path to the logic shell for this account.

Returns
Type	Description
`string`

setShell

The path to the logic shell for this account.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGecos

The GECOS (user information) entry for this account.

Returns
Type	Description
`string`

setGecos

The GECOS (user information) entry for this account.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSystemId

System identifier for which account the username or uid applies to.

By default, the empty value is used.

Returns
Type	Description
`string`

setSystemId

System identifier for which account the username or uid applies to.

By default, the empty value is used.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAccountId

Output only. A POSIX account identifier.

Returns
Type	Description
`string`

setAccountId

Output only. A POSIX account identifier.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOperatingSystemType

The operating system type where this account applies.

Returns
Type	Description
`int`

setOperatingSystemType

The operating system type where this account applies.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getName

Output only. The canonical resource name.

Returns
Type	Description
`string`

setName

Output only. The canonical resource name.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`